# FXE

## SPB

### XTD9

#### XGM

##### DOOCS

###### MAIN

Instance id: | SPB_XTD9_XGM/DOOCS/MAIN
Class id: | DoocsXGM
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Scenes: | SPB_XTD9_XGM, SPB_XTD9_XGM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

## XFEL

[add component documentation]

### FEL

[add component documentation]

#### DOOCS

[add component documentation]

##### MANAGER

#### UNDULATOR_ML

[add component documentation]

##### COLOR1_SA1

##### COLOR1_SA2

#### XGM

[add component documentation]

##### XGM_3331_FXE

## FXE

### AUXT

#### CSLIT

##### ENC

###### BLADE1_IN_OUT

Instance id: | FXE_AUXT_CSLIT/ENC/BLADE1_IN_OUT
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_AUXT_CSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE2_IN_OUT

Instance id: | FXE_AUXT_CSLIT/ENC/BLADE2_IN_OUT
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_AUXT_CSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE3_IN_OUT

Instance id: | FXE_AUXT_CSLIT/ENC/BLADE3_IN_OUT
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_AUXT_CSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE4_IN_OUT

Instance id: | FXE_AUXT_CSLIT/ENC/BLADE4_IN_OUT
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_AUXT_CSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MDL

###### MAIN

Instance id: | FXE_AUXT_CSLIT/MDL/MAIN
Class id: | SlitSystem
Host: | fxe-rr-sys-con-4
Alias: | fxe-rr-sys-con-4
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: | FXE_AUXT_CSLIT/MDL/MAIN|SimpleControl, FXE_AUXT_CSLIT/MDL/MAIN|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

###### BLADE1_IN_OUT

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.

###### BLADE2_IN_OUT

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.

###### BLADE3_IN_OUT

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.

###### BLADE4_IN_OUT

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.

#### LIC

##### DOOCS

###### PPLASER

Instance id: | FXE_AUXT_LIC/DOOCS/PPLASER
Class id: | DoocsPhaseshifter
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

###### PPL_M_PATTERN

Instance id: | FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN
Class id: | PplMultiSubPattern
Host: | la1-br-ppl-con-pattern
Alias: | la1-br-ppl-con-pattern
Git repo: | https://git.xfel.eu/karaboDevices/PplPattern
Last modified: | 2021-09-27T13:58:56.750+02:00
Created at: | 2018-08-06T14:02:03.000+02:00
Main authors: | Fabbri, Hauf
Latest tag: | 1.6.0-2.11.0
Deployment tag: | 1.6.0-2.11.0
Installed tag: | 1.5.6-2.10.0
Scenes: | FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|multi_subpattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Periodic SubPattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Arbitrary SubPattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Periodic SubPattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Periodic SubPattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Periodic SubPattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Periodic SubPattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Arbitrary SubPattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Periodic SubPattern, FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Arbitrary SubPattern
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Device is installed in development mode!

Warning

Might be hot-fixed, dt=56 days, 14:58:00!

Warning

The installed tag (1.5.6-2.10.0) does not match tags mentioned in the deployment ([‘1.6.0-2.11.0’])!

PPL multi sub pattern

The `PplMultiSubPattern` device is documented in pplPattern:welcome

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- doocsTimingServer:
    The name of Doocs timing server to contact
- doocsPatternServer:
    The name of Doocs server to contact for user-defined patterns
- pollingTime:
    Interval to wait before polling for an update from Doocs
- userName:
    The user name of the operator running the server/device
- userGroupName:
    The user-group in the system to be used when contacting the Doocs server to change the ppl pattern. In can happen that some users belong to different groups and they should choose one of them. This will provide the list of bits allowed to be modified by that user-group.
- userLaserBit:
    Selection of the ppl “User Laser” bit to use. Some users can be authorized to write on different bits of the “Bunch Pattern Table” in the Doocs server, according to which group they belong to. The smallest bit is chosen by defaulty, but they can select another one among the allowed ones.
- xfelTrainLength:
    The length of the xfel train
- xfelBunchCharge:
    The charge in the xfel bunches
- xfelBunchTiming:
    The bunch timing wrt to start of train.
- baseFrequency:
    Base frequency for the electron bunches.
- frequencyTable:
    Lookup table for values of the allowed pump-laser pulse frequency
- readFromDoocs:
    Read the current pattern configuration set in the Doocs server
- writeToDoocs:
    The patterns set by the user are written to the Doccs server
- writeSequenceToDoocs:
    The pattern sequence set by the user is written to the Doocs server. To apply it click on ‘Apply User Multi-Patterns’
- availableScenes:
    Scenes for the PplPattern
- isMultiPatternAllowed:
    This Boolean should be true in the Doocs server in order to use the user ppl patterns
- patternType:
    One of the eight possible (A to H) patterns configurable by the user. Select it to read its current status in DOOCS and/or to modify it.
- patternUserSequence:
    The pattern sequence (N[A] + M[B] …). Write Config to Doocs to set a new sequence
- patternDoocsSequence:
    The pattern sequence (N[A] + M[B] …). Read Config from Doocs to retrieve current sequence.
- userPplPattern:
    Locally selected pattern to fire PPL
- doocsPplPattern:
    Actual pattern to fire PPL running in Doocs
- pplTrainLength:
    The length of the complete burst (comprising laser pulses and empty bunches), from first to last pulse in a train.
- totBurstDuration:
    Duration of complete burst from first to last pulse in a train.
- subpattern_0:
    subpattern 0
- subpattern_1:
    subpattern 1
- subpattern_2:
    subpattern 2
- subpattern_3:
    subpattern 3

Release History
1.6.0-2.11.0

Created: | 2021-09-22T10:58:06.000+02:00
Author: | Steffen Hauf
Notes: |

1.5.7-2.11.0

Created: | 2021-08-31T14:47:43.000+02:00
Author: | Riccardo Fabbri
Notes: | Software reset added

1.5.6-2.10.0

Created: | 2021-02-09T10:18:53.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.5.5-2.9.1

Created: | 2020-08-17T14:00:55.000+02:00
Author: | Riccardo Fabbri
Notes: | Aligned with timeserver change (output is now DAQ compatible).

1.5.4-2.9.1

Created: | 2020-08-17T13:01:20.000+02:00
Author: | Riccardo Fabbri
Notes: | Input Channel implemented.

1.5.3-2.9.1

Created: | 2020-07-24T18:32:20.000+02:00
Author: | Riccardo Fabbri
Notes: | PplOverview: Bug/Fix when comparing arrays in decode_bunch_pattern.

1.5.2-2.9.1

Created: | 2020-07-23T16:32:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Implemented interval for pattern refresh.

1.5.1-2.9.1

Created: | 2020-06-30T13:44:20.000+02:00
Author: | Riccardo Fabbri
Notes: | Merge of similar functions.

1.5.0-2.9.1

Created: | 2020-06-30T12:10:56.000+02:00
Author: | Riccardo Fabbri
Notes: | Setter_periodic_pattern: with zero pulses we should have the pattern length to default 1 (one empty).

1.4.9-2.9.1

Created: | 2020-06-29T11:28:47.000+02:00
Author: | Riccardo Fabbri
Notes: | The update of key isOnPplGrid is independent from update of key isPeriodic.

1.4.8-2.9.1

Created: | 2020-06-11T10:41:52.000+02:00
Author: | Riccardo Fabbri
Notes: | Updated dependencies on doocsapi and euxfel_bunch_pattern.

1.4.7-2.7.1

Created: | 2020-04-03T16:55:23.000+02:00
Author: | Riccardo Fabbri
Notes: | Branch Feat/Refactoring merged to master

1.4.6-2.7.1

Created: | 2020-04-03T16:17:18.000+02:00
Author: | Riccardo Fabbri
Notes: | Refactoring: Label changed and keys moved

1.4.5-2.7.1

Created: | 2020-04-03T11:05:29.000+02:00
Author: | Riccardo Fabbri
Notes: | Refactoring: Obsolete intermediate steps removed for clarity

1.4.4-2.7.1

Created: | 2020-04-01T19:26:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Refactoring: Fix/remove not needed code in bases

1.4.3-2.7.1

Created: | 2020-04-01T15:58:54.000+02:00
Author: | Riccardo Fabbri
Notes: | Refactoring: DaqPolicy updated

1.4.2-2.7.1

Created: | 2020-04-01T11:30:46.000+02:00
Author: | Riccardo Fabbri
Notes: | Refactoring: Align Unittest

1.4.1-2.7.1

Created: | 2020-03-31T15:00:38.000+02:00
Author: | Riccardo Fabbri
Notes: | Refactoring: Align the key to set the ppl grid frequency with the actual pulse frequency in subpattern

1.4.0-2.7.1

Created: | 2020-03-31T12:14:55.000+02:00
Author: | Riccardo Fabbri
Notes: | Refactoring: Optimizing code in _setter_periodic_pattern

1.3.9-2.7.1

Created: | 2020-03-30T10:27:16.000+02:00
Author: | Riccardo Fabbri
Notes: | Refactoring: Remove redundant index column in lookup table

###### PPODL

Instance id: | FXE_AUXT_LIC/DOOCS/PPODL
Class id: | DoocsOpticalDelay
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Scenes: | PPODL, Custom_Motors-GI_comm
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

###### TANGERINE

Instance id: | FXE_AUXT_LIC/DOOCS/TANGERINE
Class id: | DoocsPhaseshifter
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Scenes: | Tangerine Phaseshifter
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

###### BAM_1932M

DoocsBunchArrivalMonitors Documentation

The `DoocsBunchArrivalMonitors` device is documented in doocsdevices:buncharrivalmonitors

###### BAM_1932S

DoocsBunchArrivalMonitors Documentation

The `DoocsBunchArrivalMonitors` device is documented in doocsdevices:buncharrivalmonitors

###### PPL_PATTERN_OVERVIEW

##### MDL

###### INTENSITY

Instance id: | FXE_AUXT_LIC/MDL/INTENSITY
Class id: | WavePlateControl
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/wavePlateControl
Last modified: | 2020-11-24T07:54:46.000+01:00
Created at: | 2019-08-15T11:36:49.000+02:00
Main authors: | Hauf, Haufs, Degon
Latest tag: | 1.0.2-2.10.0
Deployment tag: | 1.0.2-2.10.0
Installed tag: | 1.0.2-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- move:
    Move to absolute position specified by targetPosition.
- stop:
    Stop axis.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- actualPosition:
    The actual position of the intensity axis.
- targetPosition:
    Position argument for move. Defines the intensity ratio
- stepLength:
    Step length used in Step Up/Step Down.
- 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.
- zeroAngle:
    The position of the motor where the zero angle is defined
- offsetIntensity:
    Defines the lowest soft limit
- availableScenes:
    Scenes from the Waveplate Control device

Release History
1.0.2-2.10.0

Created: | 2020-11-24T08:03:17.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.2-2.6.0

Created: | 2019-09-06T17:52:12.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.6.0

Created: | 2019-09-04T16:52:14.000+02:00
Author: | Dennis Goeries
Notes: |

#### DWI0

[add component documentation]

##### MDL

[add component documentation]

###### MONITOR

Instance id: | FXE_AUXT_DWI0/MDL/MONITOR
Class id: | BeamPositionMonitor
Host: | fxe-rr-sys-con-4
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/beamPositionMonitor
Last modified: | 2021-04-13T23:18:59.000+02:00
Created at: | 2018-08-16T18:02:48.000+02:00
Main authors: | Haufs, Wajid, Cas
Latest tag: | 1.7.1-2.10.0
Deployment tag: | 1.7.1-2.10.0
Scenes: | FXE_AUXT_DWI0/MDL/MONITOR, FXE_IPM_CORR, FXE_AUXT_DWI0_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!

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
- topChannel:
    Please specify the ADC channel which correspond to Top
- bottomChannel:
    Please specify the ADC channel which correspond to Bottom
- leftChannel:
    Please specify the channel which correspond to Left
- rightChannel:
    Please specify the channel which correspond to Right
- calibrationFactorX:
    Calibration Factor to align beam position in x direction
- calibrationFactorY:
    Calibration Factor to align beam position in y direction
- fetchUpperBound:
    If true the value of upper bound will be computed from digitizer device and will be equal to number of pulses
- upperBound:
    upper range of window to select desired pulses
- lowerBound:
    Lower range of window to select desired pulses
- temporalAverage:
    Average is evaluated over N last Trains
- numberOfPulses:
    Number of pulses per train
- pulseThreshold:
    Threshold to validate the pulse
- trainThreshold:
    Threshold to validate the train
- pulseValidity:
    True, if a value of all channels at a given pulses are greater than pulse threshold otherwise false
- trainValidity:
    True, if pulseValidity of all channels are greater than train threshold otherwise false
- quadrant:
    Quadrant
- scatterPosition:
    Scatter Position Node

Release History
1.7.1-2.10.0

Created: | 2020-11-24T09:49:13.000+01:00
Author: | Wajid Ehsan
Notes: | Update version

1.7.0-2.9.0

Created: | 2020-11-03T15:33:31.000+01:00
Author: | Wajid Ehsan
Notes: | Get the value of the upper bound from the digitizer device.

1.6.0-2.7.0

Created: | 2020-05-04T12:55:53.000+02:00
Author: | Wajid Ehsan
Notes: | Scatter plot for standard deviation

1.5.0-2.7.0

Created: | 2020-03-26T11:11:17.000+01:00
Author: | Wajid Ehsan
Notes: | This device now gets data from digitizerData MDL device. which has different APD channels per board

1.4.1-2.4.0

Created: | 2019-06-07T16:31:10.000+02:00
Author: | Wajid Ehsan
Notes: | include Standard deviation

1.4.0-2.4.0-hotfix

Created: | 2019-06-03T18:11:25.000+02:00
Author: | CAS
Notes: | unset value will give exception

1.4.0-2.4.0

Created: | 2019-05-28T13:12:48.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of APD class

1.3.3-2.4.0

Created: | 2019-05-22T16:55:53.000+02:00
Author: | Wajid Ehsan
Notes: | Include Temporal Standard deviation

1.3.2-2.4.0

Created: | 2019-05-09T17:30:44.000+02:00
Author: | Wajid Ehsan
Notes: | Include Standard deviation

1.3.1-2.3.2

Created: | 2019-03-07T18:34:01.000+01:00
Author: | Wajid Ehsan
Notes: | Take absolute value of APD data for pulse validity

1.3.0-2.3.2

Created: | 2019-03-05T17:56:44.000+01:00
Author: | Wajid Ehsan
Notes: | Pulse and train validity check

1.2.0-2.3.2

Created: | 2019-02-15T17:04:14.000+01:00
Author: | Wajid Ehsan
Notes: | Separate channel for Digitizer APD data

1.1.0-2.2.4

Created: | 2018-12-20T12:31:16.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.1-2.2.4

Created: | 2018-09-17T20:38:32.000+02:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.4

Created: | 2018-09-10T10:17:12.000+02:00
Author: | Wajid Ehsan
Notes: | first version of Beam Position Monitor MDL device

#### XCP

[add component documentation]

##### MOTOR

[add component documentation]

###### X1

###### X2

###### Y1

###### Y2

#### AIO

[add component documentation]

##### ACTRL

[add component documentation]

###### OUT3

Instance id: | FXE_AUXT_AIO/ACTRL/OUT3
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUT4

Instance id: | FXE_AUXT_AIO/ACTRL/OUT4
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUT5

Instance id: | FXE_AUXT_AIO/ACTRL/OUT5
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUT6

Instance id: | FXE_AUXT_AIO/ACTRL/OUT6
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUT7

Instance id: | FXE_AUXT_AIO/ACTRL/OUT7
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUT8

Instance id: | FXE_AUXT_AIO/ACTRL/OUT8
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUT_HV_USET

Instance id: | FXE_AUXT_AIO/ACTRL/OUT_HV_USET
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUT_LLS3_SETPOINT

Instance id: | FXE_AUXT_AIO/ACTRL/OUT_LLS3_SETPOINT
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

[add component documentation]

###### IN4

Instance id: | FXE_AUXT_AIO/ASENS/IN4
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### IN5

Instance id: | FXE_AUXT_AIO/ASENS/IN5
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### IN6

Instance id: | FXE_AUXT_AIO/ASENS/IN6
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### IN7

Instance id: | FXE_AUXT_AIO/ASENS/IN7
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### IN8

Instance id: | FXE_AUXT_AIO/ASENS/IN8
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### IN_HV_IREAD

Instance id: | FXE_AUXT_AIO/ASENS/IN_HV_IREAD
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### IN_HV_UREAD

Instance id: | FXE_AUXT_AIO/ASENS/IN_HV_UREAD
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### IN_LPM

Instance id: | FXE_AUXT_AIO/ASENS/IN_LPM
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.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: | FXE_AUXT_AIO/ASENS/SPARE1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.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: | FXE_AUXT_AIO/ASENS/SPARE2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.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: | FXE_AUXT_AIO/ASENS/SPARE3
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.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]

###### VSET_VMON

Instance id: | FXE_AUXT_AIO/DCTRL/VSET_VMON
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

### BR

#### SYS

##### MON

###### PLC_12

Instance id: | FXE_BR_SYS/MON/PLC_12
Class id: | BeckhoffMonitor
Host: | fxe-br-sys-con-12
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/BeckhoffMonitor
Last modified: | 2021-06-02T11:48:16.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.6-2.10.0
Deployment tag: | 1.1.6-2.10.0
Scenes: | FXE_BR_SYS/MON/PLC_12|Control, FXE_BR_SYS/MON/PLC_12|Export PLC params
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
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Provides scenes for monitor
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Instantiate all devices on selected PLC
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- reset:
    Resets this Monitor device

Release History
1.1.6-2.10.0

Created: | 2021-05-20T19:08:59.000+02:00
Author: | Sergey Esenov
Notes: | Adapted to Python 3.8.x. No new features.

1.1.5-2.9.1

Created: | 2020-11-16T10:27:47.000+01:00
Author: | Riccardo Fabbri
Notes: | Update version info according to documentation https://in.xfel.eu/readthedocs/docs/karabo/en/latest/library/device_version.html

1.1.5-2.10.0

Created: | 2020-11-16T10:27:47.000+01:00
Author: | Riccardo Fabbri
Notes: | Indicate 2.10 compatibility

1.1.4-2.4.2

Created: | 2019-05-28T11:54:20.000+02:00
Author: | Yury Kirienko
Notes: | State handling enhanced

1.1.3-2.4.0

Created: | 2019-05-21T13:20:15.000+02:00
Author: | Riccardo Fabbri
Notes: |

1.1.2-2.4.0

Created: | 2019-05-09T18:43:42.000+02:00
Author: | Riccardo Fabbri
Notes: | Bug-fix to slotInstanceGone slot: redmine #32843 Scene to select PLC added (Yury) Reset slot added

1.1.1-2.4.0

Created: | 2019-04-30T14:17:25.000+02:00
Author: | Riccardo Fabbri
Notes: | Added variables to SD_MC2BECKHOFF

1.1.0-2.4.0

Created: | 2019-04-30T10:50:21.000+02:00
Author: | Riccardo Fabbri
Notes: | Bug-fix: State error handled: redmine #32841

1.0.9-2.4.0

Created: | 2019-03-11T16:27:14.000+01:00
Author: | Alessandro Silenzi
Notes: | Compatibility with new beckhoff methods to retrieve schema

1.0.8-2.2.6

Created: | 2018-11-06T17:39:58.000+01:00
Author: | Riccardo Fabbri
Notes: | PLC config saved in git repo

1.0.7-2.2.4

Created: | 2018-09-05T12:40:28.000+02:00
Author: | Riccardo Fabbri
Notes: | Optimized Saving of PLC device config

2.0.0a0

Created: | 2018-06-15T17:56:09.000+02:00
Author: | rfabbri
Notes: | working xml download

1.0.6-2.2.0

Created: | 2018-02-05T11:06:05.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.5-2.2.0

Created: | 2018-02-05T11:06:05.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.2.0

Created: | 2018-01-17T14:05:28.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.0

Created: | 2018-01-16T16:01:25.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.0

Created: | 2018-01-16T14:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.2.0

Created: | 2018-01-15T18:00:15.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.2.0

Created: | 2018-01-15T17:46:45.000+01:00
Author: | Dennis Goeries
Notes: |

##### PLC

###### 12

Instance id: | FXE_BR_SYS/PLC/12
Class id: | BeckhoffCom
Host: | fxe-br-sys-con-12
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_BECKHOFF_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
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### 12_PLCMON

Instance id: | FXE_BR_SYS/PLC/12_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

### DAQ

#### DATA

##### DA

###### 1

Instance id: | FXE_DAQ_DATA/DA/1
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da1
Alias: | fxe-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: | DAQ Status, FXE_DAQ_RC_NEW, FXE_DAQ_Status, FXE_DAQ_RUN_CONTROL-OBSOLETE, FXE_DAQ_STATUS-OBSOLETE, FXE_DAQ_RUN_CONTROL, OLD_FXE_DAQ_RUN_CONTROL, MONITORING_DAs_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 2

Instance id: | FXE_DAQ_DATA/DA/2
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da2
Alias: | fxe-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: | DAQ Status, FXE_DAQ_RC_NEW, FXE_DAQ_RUN_CONTROL-OBSOLETE, FXE_DAQ_STATUS-OBSOLETE, FXE_DAQ_RUN_CONTROL, MONITORING_DAs_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 3

Instance id: | FXE_DAQ_DATA/DA/3
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da1
Alias: | fxe-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: | FXE_DAQ_RC_NEW, FXE_DAQ_RUN_CONTROL-OBSOLETE, FXE_DAQ_STATUS-OBSOLETE, FXE_DAQ_RUN_CONTROL, MONITORING_DAs_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 4

Instance id: | FXE_DAQ_DATA/DA/4
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da2
Alias: | fxe-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
Projects: | FXE_TEST_SLOW_DATA
Scenes: | FXE_DAQ_RC_NEW, FXE_DAQ_RUN_CONTROL-OBSOLETE, FXE_DAQ_STATUS-OBSOLETE, FXE_DAQ_RUN_CONTROL, MONITORING_DAs_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

##### DM

###### CONFIGURATOR

Instance id: | FXE_DAQ_DATA/DM/CONFIGURATOR
Class id: | RunConfigurator
Host: | fxe-br-sys-daq-srv1
Alias: | fxe-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | FXE_DAQ_RC_NEW, FXE_DAQ_DATA/DM/CONFIGURATOR|scene, FXE_DAQ_RUN_CONTROL-OBSOLETE, FXE_DAQ_RUN_CONTROL, FXE_DAQ_DATA_RUN_CONTROL_GLOBAL_STATE, FXE_DAQ_RUN_CONTROL_NSR0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### DATA_MANAGER

Instance id: | FXE_DAQ_DATA/DM/DATA_MANAGER
Class id: | DataManager
Host: | fxe-br-sys-daq-srv1
Alias: | fxe-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Resets the device in case of an error
- operationMode:
    Operation mode
- metadataSchemaVersion:
    Metadata schema version
- instrumentsList:
    List of instruments for this DAQ instance (e.g FXE,SA1)!
- proposalNumber:
    Proposal number
- experiment:
    Experiment
- sample:
    Sample
- dataType:
    Data type
- runNumber:
    Current run number
- user:
    User
- localConfiguration:
    Local configuration
- remoteConfiguration:
    Remote configuration
- debug:
    Debug mode

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### DSG_REPORT_1

Instance id: | FXE_DAQ_DATA/DM/DSG_REPORT_1
Class id: | ReportConfigGroups
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- diffResult:
    Diff Results
- topicId:
    Topic identifier used by this device
- filenameId:
    Name of the file generated and send by email
- emailToId:
    Email to where the report should be send

Release History
2.2.2-2.5.0

Created: | 2021-07-08T18:01:02.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.1-2.5.0

Created: | 2021-06-28T21:45:57.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T17:02:14.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T16:39:58.000+02:00
Author: | Nasser Al-Qudami
Notes: | In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created: | 2019-04-17T17:54:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T10:08:53.000+02:00
Author: | Nasser Al-Qudami
Notes: | Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created: | 2019-01-31T17:58:06.000+01:00
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T12:36:28.000+01:00
Author: | Nasser Al-Qudami
Notes: | This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created: | 2019-01-28T16:23:50.000+01:00
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T10:40:18.000+01:00
Author: | Nasser Al-Qudami
Notes: | Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created: | 2018-10-22T15:51:35.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T14:55:29.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-25T01:22:08.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T23:00:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T16:17:44.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T11:43:32.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T11:36:38.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T11:31:23.000+02:00
Author: | Nasser Al-Qudami
Notes: |

###### FXE_AUXT_CSLIT_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_AUXT_CSLIT_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_AUXT_LIC_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_AUXT_LIC_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_DET_LPD1M-1_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_DET_LPD1M-1_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Projects: | LPD_RUNCONFIG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### FXE_DET_MOV_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_DET_MOV_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_ENERGY_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_ENERGY_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_LPD1M-1_XTDF_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_LPD1M-1_XTDF_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon81n0
Alias: | fxe-br-sys-daq-dsg1 , spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-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’]!

Device Schema Description

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

###### FXE_MONO_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_MONO_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT1_ATT_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_ATT_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT1_BIU_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_BIU_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT1_IPM_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_IPM_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT1_MOV_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_MOV_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT1_PSLIT_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_PSLIT_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT1_SA_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_SA_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT1_TAD_CAM_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_TAD_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | FXE_DAQ_DATA/DM/FXE_OGT1_TAD_CAM_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### FXE_OGT1_TAD_GOTTHARD1_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_TAD_GOTTHARD1_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | FXE_DAQ_DATA/DM/FXE_OGT1_TAD_GOTTHARD1_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### FXE_OGT1_TAD_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_TAD_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT1_VAC_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT1_VAC_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT2_BIU-1_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT2_BIU-1_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT2_BIU-2_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT2_BIU-2_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT2_CRL_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT2_CRL_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT2_CRL_LENS_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT2_CRL_LENS_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT2_MOV_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT2_MOV_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT2_PSLIT_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT2_PSLIT_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT2_VAC_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT2_VAC_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT3_BIU_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT3_BIU_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT3_IPM_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT3_IPM_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT3_MOV_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT3_MOV_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT3_SA_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT3_SA_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_PPL_TRG_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_PPL_TRG_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_RR_SYS_DIGI_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_RR_SYS_DIGI_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SMS_CAM_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SMS_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SMS_JSS_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SMS_JSS_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SMS_MIC_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SMS_MIC_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SMS_MOV_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SMS_MOV_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SMS_USR_ALL_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SMS_USR_ALL_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SMS_USR_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SMS_USR_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | FXE_DAQ_DATA/DM/FXE_SMS_USR_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### FXE_SMS_VHS_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SMS_VHS_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | FXE_DAQ_DATA/DM/FXE_SMS_VHS_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### FXE_SMS_XEY_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SMS_XEY_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SYS_VAC2MPS_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SYS_VAC2MPS_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_X2TIMER_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_X2TIMER_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | FXE_DAQ_DATA/DM/FXE_X2TIMER_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### FXE_XAD_GEC_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_XAD_GEC_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon81n0
Alias: | fxe-br-sys-daq-dsg1 , spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-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’]!

Device Schema Description

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

###### FXE_XAD_JF1M_1_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_XAD_JF1M_1_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_XAD_JF1M_2_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_XAD_JF1M_2_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_XAD_JF500K_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_XAD_JF500K_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_XAD_PH3_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_XAD_PH3_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon81n0
Alias: | spb-br-sys-daq-dsg1 , fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T17:31:58.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Flucke
Latest tag: | 2.11.0a1
Deployment tag: | 2.11.0a1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### MDC_REMOTE

Instance id: | FXE_DAQ_DATA/DM/MDC_REMOTE
Class id: | MetadataDBRemote
Host: | fxe-br-sys-daq-srv1
Alias: | fxe-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/metadataDBRemote
Last modified: | 2021-06-23T14:42:53.000+02:00
Created at: | 2017-03-02T16:11:47.000+01:00
Main authors: | Maia, Hauf
Latest tag: | 3.3.0-2.11.1
Deployment tag: | 3.3.0-2.11.1
Projects: | SA1_RUN_MANAGEMENT, LPD_RUNCONFIG, FXE_TEST_SLOW_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
3.3.0-2.11.1

Created: | 2021-06-23T14:55:12.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.3.0-2.11.1

3.2.2-2.11.1

Created: | 2021-06-18T14:42:04.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.11.1

3.2.2-2.10.5

Created: | 2021-06-04T15:22:01.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.10.5

3.2.1-2.10.5.rc1

Created: | 2021-06-03T17:17:57.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.1-2.10.5.rc1

3.2.0-2.10.5

Created: | 2021-06-03T03:39:27.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.0-2.10.5

3.1.0-2.10.5

Created: | 2021-06-02T22:52:53.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.1.0-2.10.5

3.0.7-2.10.1-rx1

Created: | 2021-06-02T12:57:58.000+02:00
Author: | Nasser Al-Qudami
Notes: |

3.0.7-2.9.2

Created: | 2020-06-30T22:51:41.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.7-2.9.2

3.0.6-2.9.1_rc1

Created: | 2020-06-11T10:48:57.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.6-2.9.1_rc1

3.0.4-2.9.1

Created: | 2020-01-27T12:14:04.000+01:00
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.9.1

3.0.4-2.7.0

Created: | 2020-01-27T12:14:04.000+01:00
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.7.0

3.0.3-2.6.1

Created: | 2019-08-23T08:12:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.6.1

3.0.3-2.5.1

Created: | 2019-08-23T00:53:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.5.1

3.0.0-2.5.1

Created: | 2019-08-16T15:26:20.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.0-2.5.1

2.0.0-2.2.0

Created: | 2017-12-21T15:52:41.000+01:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.0

1.1.6-2.1.18

Created: | 2017-12-21T09:32:55.000+01:00
Author: | Luis Maia
Notes: | Release tag 1.1.6-2.1.18

1.1.5-2.1.18

Created: | 2017-12-20T11:48:53.000+01:00
Author: | Luis Maia
Notes: | In this tag: * Release version 1.1.5-2.1.18 * Update MetadataClient to 1.1.4.1 * Comment issue that prevents device installation via Ansible

1.1.4-2.1.16

Created: | 2017-11-10T14:19:21.000+01:00
Author: | Luis Maia
Notes: | Release tag 1.1.4-2.1.16

1.1.2-2.1.12

Created: | 2017-09-13T20:17:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 1.1.2-2.1.12

1.1.1-2.1.12

Created: | 2017-09-04T18:42:01.000+02:00
Author: | Luis Maia
Notes: | Release tag 1.1.1-2.1.12

###### OGT1_GOTTHARD_GROUP

Instance id: | FXE_DAQ_DATA/DM/OGT1_GOTTHARD_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | Run_Configuration_Group
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### RUN_CONTROL

Instance id: | FXE_DAQ_DATA/DM/RUN_CONTROL
Class id: | RunController
Host: | fxe-br-sys-daq-srv1
Alias: | fxe-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: | FXE_RunControl, Run controller, Run controller, FXE_DAQ_RC_NEW, LPD Overview, FXE_DAQ_RUN_CONTROL-OBSOLETE, FXE_DAQ_RUN_CONTROL, Detector Configuration, FXE_DAQ_DATA/MDL/CONNECTION_CHECK|overview, OLD_FXE_DAQ_RUN_CONTROL, FXE_DAQ_DATA_RUN_CONTROL_GLOBAL_STATE, FXE_DAQ_RUN_CONTROL_NSR0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Controller:
    Main controller
- slotPushToDaq:
    Push run configuration to DAQ
- slotRetrieveProposalDetails:
    Retrieve proposal details
- actions:
    Actions
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- alias:
    Device alias
- defaultMaxSize:
    Default max size for vectors when this is not specified in data schema
- runConfigurator:
    Run configurator
- dataManager:
    Data manager device
- metadataSchemaVersion:
    Metadata schema version
- proposalNumber:
    Proposal number
- proposalTitle:
    Proposal title
- proposalInstrument:
    Proposal instrument
- proposalDataPath:
    Proposal data path
- experiment:
    Experiment
- sample:
    Sample
- dataType:
    Data type
- runMsg:
    Run message
- runNumber:
    Run number
- runDetails:
    Run details
- trainId:
    Current Train Id(landmark)
- refTrainId:
    Method and offset for calculating the reference Train Id
- globalState:
    Global state details
- aggregators:
    Aggregators devices
- dataSourceToAggregatorsMapping:
    Data sources to aggregators mapping
- debug:
    Debug mode
- policy:
    Errors handling policy
- dataAggregatorsSpec:
    Data aggregators specification
- dataAggregators:
    Data aggregators

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### checkConfigGroups

Instance id: | FXE_DAQ_DATA/DM/checkConfigGroups
Class id: | CheckConfigGroups
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-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, CHECK_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- availableGroups:
    Avialable groups
- scanGroupsResult:
    Scan Results
- configuratorId:
    DAQ CONFIGURATOR device Id
- timeServerId:
    A timeServerId to get a trainId
- recentTrainId:
    Most recently published train ID from timeServer
- trainIdThreshold:
    Threshold for trainId
- checkTrainIdFrom:
    Return TrainId from device slot/configuration

Release History
2.2.2-2.5.0

Created: | 2021-07-08T18:01:02.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.1-2.5.0

Created: | 2021-06-28T21:45:57.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T17:02:14.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T16:39:58.000+02:00
Author: | Nasser Al-Qudami
Notes: | In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created: | 2019-04-17T17:54:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T10:08:53.000+02:00
Author: | Nasser Al-Qudami
Notes: | Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created: | 2019-01-31T17:58:06.000+01:00
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T12:36:28.000+01:00
Author: | Nasser Al-Qudami
Notes: | This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created: | 2019-01-28T16:23:50.000+01:00
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T10:40:18.000+01:00
Author: | Nasser Al-Qudami
Notes: | Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created: | 2018-10-22T15:51:35.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T14:55:29.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-25T01:22:08.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T23:00:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T16:17:44.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T11:43:32.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T11:36:38.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T11:31:23.000+02:00
Author: | Nasser Al-Qudami
Notes: |

###### SCAN_GROUP

Instance id: | FXE_DAQ_DATA/DM/SCAN_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | FXE_DAQ_SCAN/SM/KARABACON|MainControl, FXE_DAQ_DATA/DM/SCAN_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### FXE_DOOCS_BAMS_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_DOOCS_BAMS_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_XAD_JF1M_CTRL_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_XAD_JF1M_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_XAD_JF500K_CTRL_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_XAD_JF500K_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_PPL_LAS_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_PPL_LAS_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_OGT3_XGMD_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_OGT3_XGMD_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SCAN_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SCAN_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_XAD_GEC_GREATEYES_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_XAD_GEC_GREATEYES_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon81n0
Alias: | spb-br-sys-daq-dsg1 , fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T17:31:58.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Flucke
Latest tag: | 2.11.0a1
Deployment tag: | 2.11.0a1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FEM_MDL_LPD_GROUP

Instance id: | FXE_DAQ_DATA/DM/FEM_MDL_LPD_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_DOC_ADHOC_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_DOC_ADHOC_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_SA1_OPTICS_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_SA1_OPTICS_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### OGT3_GOTTHARD_GROUP

Instance id: | FXE_DAQ_DATA/DM/OGT3_GOTTHARD_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_AUXT_AIO_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_AUXT_AIO_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### FXE_ILH_TA_GOTTHARD_GROUP

Instance id: | FXE_DAQ_DATA/DM/FXE_ILH_TA_GOTTHARD_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

###### TEST_DOOCS_GROUP

Instance id: | FXE_DAQ_DATA/DM/TEST_DOOCS_GROUP
Class id: | RunConfigurationGroup
Host: | fxe-br-sys-daq-dsg1
Alias: | fxe-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T14:13:09.002+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

##### JNGFR

###### 1

Instance id: | FXE_DAQ_DATA/JNGFR/1
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da3
Alias: | fxe-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: | FXE_DAQ_RC_NEW, FXE_DAQ_RUN_CONTROL-OBSOLETE, JF1M, JF1M-New-Feedback, MONITORING_JNGFR_DATA, JF1M-Simple0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 2

Instance id: | FXE_DAQ_DATA/JNGFR/2
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da3
Alias: | fxe-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: | FXE_DAQ_RC_NEW, FXE_DAQ_RUN_CONTROL-OBSOLETE, JF1M, JF1M-New-Feedback, MONITORING_JNGFR_DATA, JF1M-Simple0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 3

Instance id: | FXE_DAQ_DATA/JNGFR/3
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da3
Alias: | fxe-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: | FXE_DAQ_RUN_CONTROL-OBSOLETE, FXE_DAQ_STATUS-OBSOLETE, MONITORING_JNGFR_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

##### JNGFRCTRL

[add component documentation]

###### 0

Instance id: | FXE_DAQ_DATA/JNGFRCTRL/0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da3
Alias: | fxe-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: | FXE_DAQ_RC_NEW, FXE_DAQ_RUN_CONTROL-OBSOLETE, MONITORING_JNGFR_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

##### MDL

[add component documentation]

###### CONNECTION_CHECK

##### DOC

[add component documentation]

###### 1

Instance id: | FXE_DAQ_DATA/DOC/1
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da3
Alias: | fxe-br-sys-daq-da3
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

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

##### LPD1MCTRL

[add component documentation]

###### 0

Instance id: | FXE_DAQ_DATA/LPD1MCTRL/0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-da1
Alias: | fxe-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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

#### SCAN

##### MDL

###### GRIDCREATOR

###### KARABACON

Instance id: | FXE_DAQ_SCAN/MDL/KARABACON
Class id: | Karabacon
Host: | fxe-rr-sys-con-11
Class documentation:
| Karabacon
Alias: | fxe-rr-sys-con-11
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
Installed tag: | 2.4.5-2.11.1
Scenes: | FXE_DAQ_SCAN/MDL/KARABACON|MainControl, FXE_DAQ_SCAN/MDL/KARABACON|MainControl, FXE_DAQ_SCAN/MDL/KARABACON|MainControl, FXE_DAQ_SCAN/MDL/KARABACON|MainControl, FXE_MAIN, FXE_DAQ_SCAN/MDL/KARABACON|Plot, GRID_CREATOR, FXE_DAQ_SCAN/MDL/KARABACON|scene, FXE_DAQ_SCAN/MDL/KARABACON|plot, FXE_DAQ_SCAN/MDL/KARABACON|scene, FXE_DAQ_SCAN/MDL/KARABACON|plot
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

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

###### REPEAT

###### DAQ_CONTROLLER

Instance id: | FXE_DAQ_SCAN/MDL/DAQ_CONTROLLER
Class id: | DaqController
Host: | fxe-rr-sys-con-11
Alias: | fxe-rr-sys-con-11
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
Installed 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!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- daqTimeout:
    The configuration timeout to wait for DAQ state changes
- runController:
    The deviceId of the RunController to use, starts and stops daq.
- dataAggregators:
    The deviceIds of the DataAggregators retrieved from the current RunController.
- runConfigurator:
    The deviceId of the current RunConfigurator. It is filled automatically.
- start:
    Start DAQ with the previously applied configuration
- stop:
    Stop the current run.
- setup:
    Configure the DAQ before acquisition and check device states.
- toggle:
    Pause or resume a running acquisition.

Release History
1.4.6-2.11.1

Created: | 2021-07-15T17:35:57.000+02:00
Author: | mamchykd
Notes: | Tag from master, contains the fixes related to DaqGlobaState for the Agipd and the Scantool.

1.4.5-2.11.1

Created: | 2021-07-14T20:38:33.000+02:00
Author: | mamchykd
Notes: | A tag from branch, tested with Agipd Dark Proc on Jul 13 2021. To be tested with the Scantools.

1.4.4-2.10.0-hotfix@SPB

Created: | 2021-02-24T17:55:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | For use with JungfrauDarkChar device

1.4.4-2.10.0

Created: | 2020-11-24T22:11:03.000+01:00
Author: | Wajid Ehsan
Notes: | Version Update Info

1.4.3-2.9.0

Created: | 2020-08-21T10:53:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Internal refactor needed by AgipdDaqController derived class

1.4.2-2.9.0

Created: | 2020-08-20T14:48:22.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Split-off autoFill from onInitialization

1.4.1-2.9.0

Created: | 2020-07-15T13:27:28.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.4.0-2.9.0

Created: | 2020-06-04T16:30:28.000+02:00
Author: | Istvan Mohacsi
Notes: | Added device scene.

1.3.1-2.8.0

Created: | 2020-05-14T12:43:24.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.30-2.8.0-test

Created: | 2020-04-28T11:20:59.000+02:00
Author: | Istvan Mohacsi
Notes: | The pause / resume feature was only tested on unofficial installation.

1.2.0-2.8.0

Created: | 2020-03-03T13:03:14.000+01:00
Author: | Istvan Mohacsi
Notes: |

1.1.2-2.7.0

Created: | 2020-02-20T12:52:23.000+01:00
Author: | Denys Mamchyk
Notes: | starts after waiting for a proper data aggregators state

1.1.1-2.6.0

Created: | 2019-09-27T13:19:01.000+02:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.5.0

Created: | 2019-08-29T17:29:20.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.5.0

Created: | 2019-07-09T11:22:23.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.4.0

Created: | 2019-05-16T18:38:41.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.0.0-2.4.0

Created: | 2019-04-15T17:45:23.000+02:00
Author: | Dennis Goeries
Notes: |

##### TSYS

###### SIMULATED_TRIGGER

Instance id: | FXE_DAQ_SCAN/TSYS/SIMULATED_TRIGGER
Class id: | SimulatedTrigger
Host: | fxe-rr-sys-con-11
Alias: | fxe-rr-sys-con-11
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
Installed tag: | 1.1.1-2.10.4
Scenes: | FXE_DAQ_SCAN/MDL/KARABACON|scene, JF1M_ROI_CFG
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

### DET

#### LPD1M-1

##### CAL

###### APPEND_CORRECTED

Instance id: | FXE_DET_LPD1M-1/CAL/APPEND_CORRECTED
Class id: | CppFemCombiner
Host: | sa1-br-sys-cal-2
Alias: | sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | CAL_MANAGER_old, CORRECTED_OVERVIEW, ZMQ_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW

Instance id: | FXE_DET_LPD1M-1/CAL/APPEND_RAW
Class id: | CppFemCombiner
Host: | sa1-br-sys-cal-1
Alias: | sa1-br-sys-cal-1
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, ZMQ_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW_GAIN

Instance id: | FXE_DET_LPD1M-1/CAL/APPEND_RAW_GAIN
Class id: | CppFemCombiner
Host: | sa1-br-sys-cal-3
Alias: | sa1-br-sys-cal-3
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### CAL_MANAGER

Instance id: | FXE_DET_LPD1M-1/CAL/CAL_MANAGER
Class id: | CalManager
Host: | sa1-br-sys-cal-0
Alias: | sa1-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | CAL_MANAGER_old, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘2.2.1-2.10.0-test3’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

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

Release History
2.2.1-2.10.0-test3

Created: | 2021-09-30T12:11:29.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test2

Created: | 2021-09-27T12:00:50.000+02:00
Author: | ahmedk
Notes: |

2.2.1-2.10.0-test1

Created: | 2021-09-27T11:32:59.000+02:00
Author: | ahmedk
Notes: |

2.2.0-2.10.0

Created: | 2021-07-22T11:59:10.000+02:00
Author: | Cyril Danilevski
Notes: | Add support for AGIPD Integration Time

2.1.1-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Same as 2.1.0-2.10.0

2.1.0-2.10.0

Created: | 2021-06-10T18:11:48.000+02:00
Author: | Cyril Danilevski
Notes: | Remove CalibrationProducer based devices.

2.0.0-2.10.0

Created: | 2021-05-21T14:45:50.000+02:00
Author: | Cyril Danilevski
Notes: | Implement new LPD constants.

1.20.1-2.10.0

Created: | 2021-04-20T11:55:13.000+02:00
Author: | Cyril Danilevski
Notes: | Update depends files to upgrade calibrationBase

1.20.0-2.10.0

Created: | 2021-04-19T19:28:38.000+02:00
Author: | Cyril Danilevski
Notes: | Add Module Matcher device

1.19.1-2.10.0

Created: | 2021-04-06T13:17:50.000+02:00
Author: | Karim Ahmed
Notes: |

1.19.0-2.10.0

Created: | 2021-03-29T19:00:21.000+02:00
Author: | Karim Ahmed
Notes: | AGIPD fixed gain tag

1.19.0-2.10.0-test

Created: | 2021-03-22T07:54:42.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.1-2.10.0

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: | 1.18.1-2.10.0 = 1.18.0-2.10.0-hotfix

1.18.0-2.10.0-hotfix

Created: | 2021-02-26T19:57:26.000+01:00
Author: | Karim Ahmed
Notes: |

1.18.0-2.10.0

Created: | 2021-02-24T15:50:01.000+01:00
Author: | Cyril Danilevski
Notes: |

1.18.0-2.10.0-test

Created: | 2021-02-23T13:22:22.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

1.17.0-2.10.0

Created: | 2021-01-15T14:29:51.000+01:00
Author: | Karim Ahmed
Notes: | AUTO: Add Karabo 2.10 Versioning Info and updating depends tags

1.17.0-2.10.0-test

Created: | 2020-11-24T16:15:01.000+00:00
Author: | haufs
Notes: |

1.17.0-2.9.1

Created: | 2020-10-21T16:26:49.000+02:00
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T12:27:41.000+02:00
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

###### COMBINE_CORRECTED

Instance id: | FXE_DET_LPD1M-1/CAL/COMBINE_CORRECTED
Class id: | FemDataAssembler
Host: | exflong02
Alias: | sa1-br-sys-cal-2 , spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-11-24T17:19:27.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.10.0-test
Deployment tag: | 1.4.0-2.10.0-test
Scenes: | tst, CAL_MANAGER, CORRECTED_OVERVIEW, STATS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:18:58.000Z
Author: | haufs
Notes: |

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

###### COMBINE_RAW

Instance id: | FXE_DET_LPD1M-1/CAL/COMBINE_RAW
Class id: | FemDataAssembler
Host: | exflong01
Alias: | sa1-br-sys-cal-1 , spb-br-sys-cal-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-11-24T17:19:27.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.10.0-test
Deployment tag: | 1.4.0-2.10.0-test
Scenes: | RAW_OVERVIEW, CAL_MANAGER, CORRECTED_OVERVIEW, STATS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:18:58.000Z
Author: | haufs
Notes: |

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

###### COMBINE_RAW_GAIN

Instance id: | FXE_DET_LPD1M-1/CAL/COMBINE_RAW_GAIN
Class id: | FemDataAssembler
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-11-24T17:19:27.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.10.0-test
Deployment tag: | 1.4.0-2.10.0-test
Scenes: | RAW_OVERVIEW, CAL_MANAGER, CORRECTED_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:18:58.000Z
Author: | haufs
Notes: |

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

###### FEM_SPLITTER_Q1M1

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q1M1
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-0
Alias: | sa1-br-sys-cal-0
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M2

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q1M2
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-1
Alias: | sa1-br-sys-cal-1
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M3

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q1M3
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-2
Alias: | sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M4

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q1M4
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-3
Alias: | sa1-br-sys-cal-3
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M1

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q2M1
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-4
Alias: | sa1-br-sys-cal-4
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M2

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q2M2
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-5
Alias: | sa1-br-sys-cal-5
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M3

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q2M3
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-6
Alias: | sa1-br-sys-cal-6
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M4

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q2M4
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-7
Alias: | sa1-br-sys-cal-7
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M1

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q3M1
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-0
Alias: | sa1-br-sys-cal-0
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M2

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q3M2
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-1
Alias: | sa1-br-sys-cal-1
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M3

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q3M3
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-2
Alias: | sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M4

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q3M4
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-3
Alias: | sa1-br-sys-cal-3
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M1

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q4M1
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-4
Alias: | sa1-br-sys-cal-4
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M2

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q4M2
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-5
Alias: | sa1-br-sys-cal-5
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M3

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q4M3
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-6
Alias: | sa1-br-sys-cal-6
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M4

Instance id: | FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q4M4
Class id: | CppFemSplitter
Host: | sa1-br-sys-cal-7
Alias: | sa1-br-sys-cal-7
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | RAW_OVERVIEW, CAL_MANAGER_old, CORRECTED_OVERVIEW, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### INIT

Instance id: | FXE_DET_LPD1M-1/CAL/INIT
Class id: | InitLpdOnlineCorrection
Host: | sa1-br-sys-cal-0
Class documentation:
| InitLpdOnlineCorrection
Alias: | sa1-br-sys-cal-0
Git repo: | https://git.xfel.eu/karaboDevices/calML
Last modified: | 2021-09-30T11:31:24.988+02:00
Created at: | 2018-09-04T11:04:09.000+02:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.5.0-2.10.0
Deployment tag: | 2.5.0-2.10.0
Installed tag: | 1.6-2.4.1
Scenes: | CAL_MANAGER_old, DOC_TROUBLESHOOT, DOC_TROUBLESHOOT, DOC_TROUBLESHOOT, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.6-2.4.1) does not match tags mentioned in the deployment ([‘2.5.0-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- deviceId:

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

- heartbeatInterval:

    The heartbeat interval

- alarmCondition:

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

- globalAlarmCondition:

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

- visibility:

    Configures who is allowed to see this device at all

- classId:

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

- classVersion:

    The version of the class of this device

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- lastCommand:

    The last slot called.

- archive:

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

- log:

    Logging settings

- replay_delay:

    Delay in seconds between each train data

- filterRange:

    Total frames number must be power of two

- SlotVerifyConfig:

  > Verify the consistency of the configurations between the Control device and parameter conditions in Calibration Manager device.

Release History
2.5.0-2.10.0

Created: | 2021-05-17T10:27:01.000+02:00
Author: | Cyril Danilevski
Notes: | Update LPD init device with new correction devices.

2.4.0-2.10.0

Created: | 2021-04-12T13:55:22.000+02:00
Author: | Karim Ahmed
Notes: |

2.3.0-2.10.0

Created: | 2021-02-24T15:47:57.000+01:00
Author: | Karim Ahmed
Notes: | Add support for CalCat Mapping

2.3.0-2.10.0-test

Created: | 2021-02-23T13:18:42.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

2.1-2.10.0-test

Created: | 2020-11-25T11:55:29.000+00:00
Author: | haufs
Notes: |

2.2.1-2.10.0

Created: | 2020-11-16T18:13:18.000+01:00
Author: | Cyril Danilevski
Notes: |

2.2.0-2.10.0-test

Created: | 2020-11-16T18:13:18.000+01:00
Author: | Cyril Danilevski
Notes: | For early 2.10 tests

2.2.0-2.9.1

Created: | 2020-10-21T16:21:10.000+02:00
Author: | Karim Ahmed
Notes: |

2.1.2-2.9.1-fixSplitterFilter

Created: | 2020-09-28T19:32:59.000+02:00
Author: | Thomas Michelat
Notes: |

2.1.2-2.9.1

Created: | 2020-08-14T14:55:05.000+02:00
Author: | Thomas Michelat
Notes: | Update default configuration for DSSC

2.1.1-2.9.1

Created: | 2020-07-08T13:46:27.000+02:00
Author: | Thomas Michelat
Notes: | FIX verify config

2.1-2.7.1

Created: | 2020-04-06T15:46:47.000+02:00
Author: | Mikhail Karnevskiy
Notes: |

2.0-2.7.1

Created: | 2020-01-31T10:55:39.000+01:00
Author: | Mikhail Karnevskiy
Notes: |

1.9-2.5.1

Created: | 2019-08-27T13:44:22.000+02:00
Author: | Steffen Hauf
Notes: |

1.8-2.5.1

Created: | 2019-07-30T15:46:44.000+02:00
Author: | Steffen Hauf
Notes: |

1.7-2.5.1

Created: | 2019-07-30T15:24:49.000+02:00
Author: | Steffen Hauf
Notes: |

1.6-2.4.1

Created: | 2019-07-12T10:40:29.000+02:00
Author: | Steffen Hauf
Notes: |

1.5-2.4.1

Created: | 2019-07-02T11:10:31.000+02:00
Author: | Steffen Hauf
Notes: |

1.4-2.4.1

Created: | 2019-05-16T12:01:01.000+02:00
Author: | Steffen Hauf
Notes: |

1.3-2.4.1

Created: | 2019-05-09T19:22:28.000+02:00
Author: | Steffen Hauf
Notes: |

###### OFFSET_CORR_Q1M1

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q1M1
Class id: | OffsetCorrection
Host: | exflong08
Alias: | sa1-br-sys-cal-8 , sa1-br-sys-cal-0 , spb-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q1M2

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q1M2
Class id: | OffsetCorrection
Host: | exflong01
Alias: | sa1-br-sys-cal-1 , spb-br-sys-cal-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q1M3

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q1M3
Class id: | OffsetCorrection
Host: | exflong02
Alias: | sa1-br-sys-cal-2 , spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q1M4

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q1M4
Class id: | OffsetCorrection
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q2M1

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q2M1
Class id: | OffsetCorrection
Host: | exflong04
Alias: | sa1-br-sys-cal-4 , spb-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q2M3

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q2M3
Class id: | OffsetCorrection
Host: | exflong06
Alias: | spb-br-sys-cal-6 , sa1-br-sys-cal-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q2M4

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q2M4
Class id: | OffsetCorrection
Host: | exflong07
Alias: | sa1-br-sys-cal-7 , spb-br-sys-cal-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q3M1

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q3M1
Class id: | OffsetCorrection
Host: | exflong08
Alias: | sa1-br-sys-cal-8 , sa1-br-sys-cal-0 , spb-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q3M2

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q3M2
Class id: | OffsetCorrection
Host: | exflong01
Alias: | sa1-br-sys-cal-1 , spb-br-sys-cal-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q3M3

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q3M3
Class id: | OffsetCorrection
Host: | exflong02
Alias: | sa1-br-sys-cal-2 , spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q3M4

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q3M4
Class id: | OffsetCorrection
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q4M1

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q4M1
Class id: | OffsetCorrection
Host: | exflong04
Alias: | sa1-br-sys-cal-4 , spb-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q4M2

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q4M2
Class id: | OffsetCorrection
Host: | exflong05
Alias: | spb-br-sys-cal-5 , sa1-br-sys-cal-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q4M3

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q4M3
Class id: | OffsetCorrection
Host: | exflong06
Alias: | spb-br-sys-cal-6 , sa1-br-sys-cal-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### OFFSET_CORR_Q4M4

Instance id: | FXE_DET_LPD1M-1/CAL/OFFSET_CORR_Q4M4
Class id: | OffsetCorrection
Host: | exflong07
Alias: | sa1-br-sys-cal-7 , spb-br-sys-cal-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q1M1

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q1M1
Class id: | RelativeGainCorrection
Host: | exflong08
Alias: | sa1-br-sys-cal-8 , sa1-br-sys-cal-0 , spb-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q1M2

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q1M2
Class id: | RelativeGainCorrection
Host: | exflong01
Alias: | sa1-br-sys-cal-1 , spb-br-sys-cal-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q1M3

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q1M3
Class id: | RelativeGainCorrection
Host: | exflong02
Alias: | sa1-br-sys-cal-2 , spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q1M4

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q1M4
Class id: | RelativeGainCorrection
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q2M1

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q2M1
Class id: | RelativeGainCorrection
Host: | exflong04
Alias: | sa1-br-sys-cal-4 , spb-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q2M3

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q2M3
Class id: | RelativeGainCorrection
Host: | exflong06
Alias: | spb-br-sys-cal-6 , sa1-br-sys-cal-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q2M4

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q2M4
Class id: | RelativeGainCorrection
Host: | exflong07
Alias: | sa1-br-sys-cal-7 , spb-br-sys-cal-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q3M1

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q3M1
Class id: | RelativeGainCorrection
Host: | exflong08
Alias: | sa1-br-sys-cal-8 , sa1-br-sys-cal-0 , spb-br-sys-cal-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q3M2

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q3M2
Class id: | RelativeGainCorrection
Host: | exflong01
Alias: | sa1-br-sys-cal-1 , spb-br-sys-cal-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q3M3

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q3M3
Class id: | RelativeGainCorrection
Host: | exflong02
Alias: | sa1-br-sys-cal-2 , spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q3M4

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q3M4
Class id: | RelativeGainCorrection
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q4M1

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q4M1
Class id: | RelativeGainCorrection
Host: | exflong04
Alias: | sa1-br-sys-cal-4 , spb-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q4M2

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q4M2
Class id: | RelativeGainCorrection
Host: | exflong05
Alias: | spb-br-sys-cal-5 , sa1-br-sys-cal-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q4M3

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q4M3
Class id: | RelativeGainCorrection
Host: | exflong06
Alias: | spb-br-sys-cal-6 , sa1-br-sys-cal-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RELGAIN_CORR_Q4M4

Instance id: | FXE_DET_LPD1M-1/CAL/RELGAIN_CORR_Q4M4
Class id: | RelativeGainCorrection
Host: | exflong07
Alias: | sa1-br-sys-cal-7 , spb-br-sys-cal-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-11-24T17:16:32.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Kamil, Ahmed, Michelat
Latest tag: | 1.17.0-2.10.0-test
Deployment tag: | 1.17.0-2.10.0-test
Scenes: | CAL_MANAGER
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector can be found here.

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

Created: | 2020-11-24T16:15:01.000Z
Author: | haufs
Notes: |

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

###### RESTART

Instance id: | FXE_DET_LPD1M-1/CAL/RESTART
Class id: | RestartCalServers
Host: | sa1-br-sys-cal-0
Alias: | sa1-br-sys-cal-0
Git repo: | https://git.xfel.eu/karaboDevices/calML
Last modified: | 2021-09-30T11:31:24.988+02:00
Created at: | 2018-09-04T11:04:09.000+02:00
Main authors: | Danilevski, Ahmed, Ahmedk
Latest tag: | 2.5.0-2.10.0
Deployment tag: | 2.5.0-2.10.0
Installed tag: | 1.6-2.4.1
Scenes: | CAL_MANAGER_old, DOC_TROUBLESHOOT, DOC_TROUBLESHOOT, DOC_TROUBLESHOOT, CAL_MANAGER
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.6-2.4.1) does not match tags mentioned in the deployment ([‘2.5.0-2.10.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

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

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

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings

Release History
2.5.0-2.10.0

Created: | 2021-05-17T10:27:01.000+02:00
Author: | Cyril Danilevski
Notes: | Update LPD init device with new correction devices.

2.4.0-2.10.0

Created: | 2021-04-12T13:55:22.000+02:00
Author: | Karim Ahmed
Notes: |

2.3.0-2.10.0

Created: | 2021-02-24T15:47:57.000+01:00
Author: | Karim Ahmed
Notes: | Add support for CalCat Mapping

2.3.0-2.10.0-test

Created: | 2021-02-23T13:18:42.000+01:00
Author: | Karim Ahmed
Notes: | New CalCat Mapping

2.1-2.10.0-test

Created: | 2020-11-25T11:55:29.000+00:00
Author: | haufs
Notes: |

2.2.1-2.10.0

Created: | 2020-11-16T18:13:18.000+01:00
Author: | Cyril Danilevski
Notes: |

2.2.0-2.10.0-test

Created: | 2020-11-16T18:13:18.000+01:00
Author: | Cyril Danilevski
Notes: | For early 2.10 tests

2.2.0-2.9.1

Created: | 2020-10-21T16:21:10.000+02:00
Author: | Karim Ahmed
Notes: |

2.1.2-2.9.1-fixSplitterFilter

Created: | 2020-09-28T19:32:59.000+02:00
Author: | Thomas Michelat
Notes: |

2.1.2-2.9.1

Created: | 2020-08-14T14:55:05.000+02:00
Author: | Thomas Michelat
Notes: | Update default configuration for DSSC

2.1.1-2.9.1

Created: | 2020-07-08T13:46:27.000+02:00
Author: | Thomas Michelat
Notes: | FIX verify config

2.1-2.7.1

Created: | 2020-04-06T15:46:47.000+02:00
Author: | Mikhail Karnevskiy
Notes: |

2.0-2.7.1

Created: | 2020-01-31T10:55:39.000+01:00
Author: | Mikhail Karnevskiy
Notes: |

1.9-2.5.1

Created: | 2019-08-27T13:44:22.000+02:00
Author: | Steffen Hauf
Notes: |

1.8-2.5.1

Created: | 2019-07-30T15:46:44.000+02:00
Author: | Steffen Hauf
Notes: |

1.7-2.5.1

Created: | 2019-07-30T15:24:49.000+02:00
Author: | Steffen Hauf
Notes: |

1.6-2.4.1

Created: | 2019-07-12T10:40:29.000+02:00
Author: | Steffen Hauf
Notes: |

1.5-2.4.1

Created: | 2019-07-02T11:10:31.000+02:00
Author: | Steffen Hauf
Notes: |

1.4-2.4.1

Created: | 2019-05-16T12:01:01.000+02:00
Author: | Steffen Hauf
Notes: |

1.3-2.4.1

Created: | 2019-05-09T19:22:28.000+02:00
Author: | Steffen Hauf
Notes: |

##### CC

###### MON_0

Instance id: | FXE_DET_LPD1M-1/CC/MON_0
Class id: | Ccmon
Host: | fxe-rr-sys-utc-1
Alias: | testdaq-rr-sys-utca-1 , fxe-rr-04 , fxe-rr-sys-utc-1-mch
Git repo: | https://git.xfel.eu/karaboDevices/ccmon
Last modified: | 2021-08-03T10:38:08.000+02:00
Created at: | 2017-03-02T15:01:59.000+01:00
Main authors: | Ehsan, Ehsanw, Silenzi
Latest tag: | 1.2.8-2.11.1
Deployment tag: | 1.2.8-2.11.1
Installed tag: | 1.2.0-2.10.0
Scenes: | Veto Config, CnC Spare Trigger, CnC Quick Configuration, LPD Overview, CnC Trigger Simulation, Prepare VETO Pattern, FEM Overview, Detector Configuration, CnC VETO Settings, Calibration Pipeline Status
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

LPD General Documentation

A general introduction to the LPD detector 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
- pciedev:
    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5
- mapdir:
    The filesystem directory with XML files assigning logical names to internal locations in device space
- pollingInterval:
    The requested polling interval in seconds
- sdelay:
    Delay between consecutive settings
- project_version:
    Version of implemented project
- project_date:
    Date of the last change of the project.
- project_user:
    User defined register for free use within software to store and read back project related information.
- firmware_ready:
    Firmware status
- fem_status:
    FEM Status: (1) - OK (0) - not OK
- onboard_clock:
    On-board Clock: (1) - Present (0) - Absent
- tr_clock:
    Timing Receiver Clock: (1) - Present (0) - Absent
- fem_clock:
    FEM Clock: (1) - Present (0) - Absent
- timing_synch:
    When 1 - C&C synch with Timing information
- ccStandardOperation:
    Switch to standard (normal) operation.
- reset:
    Full reset.
- softReset:
    Reset clock.
- train_id:
    Current Timing Receiver Train ID (64 bits)
- train_id_mismatch:
    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID
- pll_ratio:
    Current PLL clock multiplier
- cc_slave:
    C&C board mode: Slave or Master
- cc_standalone:
    When 1 - C&C in standalone mode
- cc_trigger_mode:
    C&C Trigger mode: “Internal” or “Timing board”
- trigger_test_mode:
    Trigger simulation mode: “Continuous” or “Single”
- trigger_delay:
    Number clock cycles to delay the trigger start signal.
- trigger_period:
    Continuous trigger period
- stop_trigger_limit:
    Time between START and STOP command in 99 MHz clock cycles
- train_id_test:
    Initial train ID for standalone mode
- train_id_update:
    Writing 1 will update Train ID test
- pattern_index_test:
    Initial bunch pattern index for standalone mode.
- pattern_index_update:
    Writing 1 will update Pattern Index test
- ccTriggerStart:
    Trigger simulation start.
- ccTriggerStop:
    Trigger simulation stop.
- fast_data:
    When true - enable FAST data
- fast_custom_message:
    When 1 - send a fixed payload on the FAST line.
- fast_custom_command:
    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering

Release History
1.2.8-2.11.1

Created: | 2021-08-03T11:11:20.000+02:00
Author: | Wajid Ehsan
Notes: | Remove register WORD_VETO_SIM_RESET

1.2.7-2.11.1

Created: | 2021-07-06T16:36:46.000+02:00
Author: | Wajid Ehsan
Notes: | update utca config tag

1.2.6-2.11.1

Created: | 2021-07-05T14:13:55.000+02:00
Author: | Wajid Ehsan
Notes: | update iibus tag (Fixed bug with 32 bit signed values)

1.2.5-2.11.1

Created: | 2021-06-23T17:24:40.000+02:00
Author: | Wajid Ehsan
Notes: | Don’t poll if bunch pattern decoding is not enabled

1.2.4-2.11.1

Created: | 2021-06-15T18:08:50.000+02:00
Author: | Wajid Ehsan
Notes: | Update Depends tag

1.2.3-2.11.1

Created: | 2021-06-14T15:05:33.000+02:00
Author: | Wajid Ehsan
Notes: | Add tag for uTCAConfigurations

1.2.2-2.11.1

Created: | 2021-06-09T11:35:28.000+02:00
Author: | Wajid Ehsan
Notes: | Use tag for iibus related devices

1.2.1-2.11.1

Created: | 2021-06-02T20:23:01.000+02:00
Author: | Andrea Parenti
Notes: | Feat/v37 + init fixes + Install pciedev_io.h on CI

1.2.0-2.10.0

Created: | 2020-11-23T18:14:00.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.7.1

Created: | 2020-02-18T11:32:07.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.2.0-2.7.1-select-backplane-trigger-01

Created: | 2020-02-10T11:43:05.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.0-2.7.0

Created: | 2020-01-13T15:58:57.000+01:00
Author: | Gabriele Giovanetti
Notes: | Parameters get timestamp and trainid from local hardware.

1.0.5-2.2.4

Created: | 2018-08-03T11:10:45.000+02:00
Author: | Alessandro Silenzi
Notes: | minor fix due to name change in C&C firmware project

1.0.4-2.2.3

Created: | 2018-06-14T10:00:10.000+02:00
Author: | Andrea Parenti
Notes: | Update register names for C&C 4.1.0

1.0.3-2.2.3

Created: | 2018-06-06T11:56:51.000+02:00
Author: | Andrea Parenti
Notes: | Two fixes to expected paramers

1.0.2-2.2.1

Created: | 2018-02-22T10:59:04.000+01:00
Author: | Andrea Parenti
Notes: | Fix Netbeans configuration and Makefile for Release mode

1.0.1-2.2.1

Created: | 2018-02-09T14:08:32.000+01:00
Author: | Andrea Parenti
Notes: | Add 2.1 and 2.2 to KARABO_CLASSINFO

1.0.1-2.1.0

Created: | 2018-01-17T16:33:25.000+01:00
Author: | esenov
Notes: |

1.0.0-2.1

Created: | 2017-05-15T10:19:36.000+02:00
Author: | Andrea Parenti
Notes: | AGIPD Squad version

###### MON_1

Instance id: | FXE_DET_LPD1M-1/CC/MON_1
Class id: | Ccmon
Host: | fxe-exp-sys-utc-1
Alias: | fxe-exp-sys-utc-1-mch
Git repo: | https://git.xfel.eu/karaboDevices/ccmon
Last modified: | 2021-08-03T10:38:08.000+02:00
Created at: | 2017-03-02T15:01:59.000+01:00
Main authors: | Ehsan, Ehsanw, Silenzi
Latest tag: | 1.2.8-2.11.1
Deployment tag: | 1.2.8-2.11.1
Installed tag: | 1.2.0-2.10.0
Scenes: | CnC Quick Configuration (Duplicate MON_1, WIP), CnC Trigger Simulation (Duplicate MON_1, WIP), Prepare VETO Pattern (Duplicate MON_1, WIP), CnC VETO Settings (Duplicate MON_1, WIP), CnC Spare Trigger (Duplicate MON_1, WIP), Veto Config (Duplicate MON_1, WIP), CnC Quick Configuration( Duplicate MON_1), CnC Trigger Simulation (Duplicate MON_1), Prepare VETO Pattern (Duplicate MON_1), CnC VETO Settings (Duplicate MON_1), CnC Spare Trigger (Duplicate MON_1), Veto Config (Duplicate MON_1)
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

LPD General Documentation

A general introduction to the LPD detector 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
- pciedev:
    Device file in /dev directory that indicates existence of hardware and loaded driver. Example: /dev/pciedevs5
- mapdir:
    The filesystem directory with XML files assigning logical names to internal locations in device space
- pollingInterval:
    The requested polling interval in seconds
- sdelay:
    Delay between consecutive settings
- project_version:
    Version of implemented project
- project_date:
    Date of the last change of the project.
- project_user:
    User defined register for free use within software to store and read back project related information.
- firmware_ready:
    Firmware status
- fem_status:
    FEM Status: (1) - OK (0) - not OK
- onboard_clock:
    On-board Clock: (1) - Present (0) - Absent
- tr_clock:
    Timing Receiver Clock: (1) - Present (0) - Absent
- fem_clock:
    FEM Clock: (1) - Present (0) - Absent
- timing_synch:
    When 1 - C&C synch with Timing information
- ccStandardOperation:
    Switch to standard (normal) operation.
- reset:
    Full reset.
- softReset:
    Reset clock.
- train_id:
    Current Timing Receiver Train ID (64 bits)
- train_id_mismatch:
    When 1, there is a mismatch between TR and LLL(Low Latency Link protocol between VETO Unit and C&C) Train ID
- pll_ratio:
    Current PLL clock multiplier
- cc_slave:
    C&C board mode: Slave or Master
- cc_standalone:
    When 1 - C&C in standalone mode
- cc_trigger_mode:
    C&C Trigger mode: “Internal” or “Timing board”
- trigger_test_mode:
    Trigger simulation mode: “Continuous” or “Single”
- trigger_delay:
    Number clock cycles to delay the trigger start signal.
- trigger_period:
    Continuous trigger period
- stop_trigger_limit:
    Time between START and STOP command in 99 MHz clock cycles
- train_id_test:
    Initial train ID for standalone mode
- train_id_update:
    Writing 1 will update Train ID test
- pattern_index_test:
    Initial bunch pattern index for standalone mode.
- pattern_index_update:
    Writing 1 will update Pattern Index test
- ccTriggerStart:
    Trigger simulation start.
- ccTriggerStop:
    Trigger simulation stop.
- fast_data:
    When true - enable FAST data
- fast_custom_message:
    When 1 - send a fixed payload on the FAST line.
- fast_custom_command:
    FAST command to send in a Fixed Payload configuration.

Possible commands: START,STOP,RESET

- fast_custom_checksum:
    When 1 - send checksum in a Fixed Payload configuration.
- veto_data:
    When 1 - VETO output is enable
- veto_mode:
    When 1 - simulated VETO
- veto_num_vetos:
    Number of VETOs data packets to send with each trigger.
- veto_sim_same_values:
    VETO simulation values: (0) - rotate all available values on the memory, (1) - always send the same values
- veto_lll:
    When (1) - LLL VETO is available. LLL stands for Low Latency Link protocol, used between VETO Unit & C&C
- veto_command:
    VETO command: VETO(110), NO VETO(101), GOLDEN(111). GOLDEN means never vetoed
- veto_bunch_id:
    VETO Bunch ID (12 bits)
- veto_latency:
    Time between the start trigger and VETO in 99 MHz clock cycles.
- veto_memory:
    Memory with VETO data sent
- veto_sim_memory:
    Memory with simulated VETO data.
- veto_pattern:
    Array of VETO commands and BunchIDs
- veto_pulses:
    Pulse numbers marked as VETO
- no_veto_pulses:
    Pulse numbers marked as NO VETO
- golden_pulses:
    Pulse numbers tagged as GOLDEN
- n_no_veto_number:
    Number of pulses with NO VETO tag.
- mth_pulse_no_veto:
    Mark every m-th pulse from N pulses as NO VETO pulse.
- pattern_filename:
    File name of the pattern text file
- readVetoMemory:
    Read last VETO Pattern
- readVetoSimMemory:
    Read VETO Simulation Memory
- nNoVetoPattern:
    Create N ‘NO VETO’ Pattern (N should be defined
- nNoVetoOnMthPulsePattern:
    Create N ‘NO VETO’ pulse on every M-th pulse.
- saveVetoPatternFile:
    Save VETO pattern to disk file.
- uploadPatternFile:
    Upload VETO pattern from file into VETO simulation memory.
- spare_trigger_enable:
    When 1 - enable Trigger output on Spare connector
- spare_trigger_delay:
    Spare trigger delay from original trigger
- spare_trigger_width:
    Width of Spare trigger
- spare_trigger_period:
    Number of clock cycles between spare triggers
- spare_trigger_repeat:
    Number of Spare triggers to generate
- spare_trigger_mask_enable:
    When 1 = mask Spare trigger output
- spare_trigger_mask:
    Mask Memory for spare trigger
- spare_trigger_mask_file:
    Mask file for spare trigger
- uploadMaskValues:
    Save VETO pattern to disk file.
- mlvdsTriggerMask:
    Mask for MLVDS backplane trigger selection. Bit position corresponds to MLVDS line number, e.g.: line 2 -> mask = 0x4, line 3 -> mask = 0x8, both lines 2 and 3 (or-ed) -> mask = 0xC.There are in total 8 lines, but line 0 and 1 are normally not used for triggering

Release History
1.2.8-2.11.1

Created: | 2021-08-03T11:11:20.000+02:00
Author: | Wajid Ehsan
Notes: | Remove register WORD_VETO_SIM_RESET

1.2.7-2.11.1

Created: | 2021-07-06T16:36:46.000+02:00
Author: | Wajid Ehsan
Notes: | update utca config tag

1.2.6-2.11.1

Created: | 2021-07-05T14:13:55.000+02:00
Author: | Wajid Ehsan
Notes: | update iibus tag (Fixed bug with 32 bit signed values)

1.2.5-2.11.1

Created: | 2021-06-23T17:24:40.000+02:00
Author: | Wajid Ehsan
Notes: | Don’t poll if bunch pattern decoding is not enabled

1.2.4-2.11.1

Created: | 2021-06-15T18:08:50.000+02:00
Author: | Wajid Ehsan
Notes: | Update Depends tag

1.2.3-2.11.1

Created: | 2021-06-14T15:05:33.000+02:00
Author: | Wajid Ehsan
Notes: | Add tag for uTCAConfigurations

1.2.2-2.11.1

Created: | 2021-06-09T11:35:28.000+02:00
Author: | Wajid Ehsan
Notes: | Use tag for iibus related devices

1.2.1-2.11.1

Created: | 2021-06-02T20:23:01.000+02:00
Author: | Andrea Parenti
Notes: | Feat/v37 + init fixes + Install pciedev_io.h on CI

1.2.0-2.10.0

Created: | 2020-11-23T18:14:00.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.7.1

Created: | 2020-02-18T11:32:07.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.2.0-2.7.1-select-backplane-trigger-01

Created: | 2020-02-10T11:43:05.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.0-2.7.0

Created: | 2020-01-13T15:58:57.000+01:00
Author: | Gabriele Giovanetti
Notes: | Parameters get timestamp and trainid from local hardware.

1.0.5-2.2.4

Created: | 2018-08-03T11:10:45.000+02:00
Author: | Alessandro Silenzi
Notes: | minor fix due to name change in C&C firmware project

1.0.4-2.2.3

Created: | 2018-06-14T10:00:10.000+02:00
Author: | Andrea Parenti
Notes: | Update register names for C&C 4.1.0

1.0.3-2.2.3

Created: | 2018-06-06T11:56:51.000+02:00
Author: | Andrea Parenti
Notes: | Two fixes to expected paramers

1.0.2-2.2.1

Created: | 2018-02-22T10:59:04.000+01:00
Author: | Andrea Parenti
Notes: | Fix Netbeans configuration and Makefile for Release mode

1.0.1-2.2.1

Created: | 2018-02-09T14:08:32.000+01:00
Author: | Andrea Parenti
Notes: | Add 2.1 and 2.2 to KARABO_CLASSINFO

1.0.1-2.1.0

Created: | 2018-01-17T16:33:25.000+01:00
Author: | esenov
Notes: |

1.0.0-2.1

Created: | 2017-05-15T10:19:36.000+02:00
Author: | Andrea Parenti
Notes: | AGIPD Squad version

##### CCML

###### VETO

Instance id: | FXE_DET_LPD1M-1/CCML/VETO
Class id: | ClockAndControlML
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/clockAndControlML
Last modified: | 2021-06-07T13:51:47.000+02:00
Created at: | 2017-07-19T09:25:01.000+02:00
Main authors: | Danilevski, Hauf, Haufs
Latest tag: | 2.0.0-2.10.0
Deployment tag: | 2.0.0-2.10.0
Installed tag: | 2.0.0-2.10.0
Scenes: | Veto Config, Veto Config (Duplicate MON_1, WIP), Veto Config (Duplicate MON_1)
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

LPD General Documentation

A general introduction to the LPD detector 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
- proxy:
    The Clock and Control device
- uploadOk:
    Was the upload to Veto Memory Successful
- displayedSequence:
    Sequence generated from user input
- displayedBinOutput:
    The bits that are sent to the C&C, one entry for each bunch, ordered
- displayedOutput:
    The bits that are sent to the C&C, one entry for each bunch, ordered, human readable
- vetoMode:
    The mode in which to generate the pattern.
- inputString:
    The input can be valid python code, that generates either an integer, or an iterable of integers. When doing equations, remember to cast your floats to ints.
- applyPattern:
    Save VETO pattern to disk file, as configured in the CCMon device, and upload it to the board.

Release History
2.0.0-2.10.0

Created: | 2021-05-06T13:23:24.000+02:00
Author: | Cyril Danilevski
Notes: |

1.2.0-2.10.0

Created: | 2020-11-23T18:16:33.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.2.4

Created: | 2018-06-27T14:36:03.000+02:00
Author: | Gabriele Giovanetti
Notes: | Set DAQ policies

1.1.1-2.2.1

Created: | 2018-01-29T15:47:28.000+01:00
Author: | Cyril Danilevski
Notes: |

1.1.0-2.2.0

Created: | 2017-12-20T17:25:03.000+01:00
Author: | Cyril Danilevski
Notes: |

1.1.0-2.1.18

Created: | 2017-12-20T17:25:03.000+01:00
Author: | Cyril Danilevski
Notes: |

1.0.1-2.1.12

Created: | 2017-08-17T10:42:30.000+02:00
Author: | Cyril Danilevski
Notes: | Fixes the indexing of bunches

1.0.0-2.1.12

Created: | 2017-07-24T11:26:55.000+02:00
Author: | Cyril Danilevski
Notes: | This is the same commit as 1.0.0-2.1, but uses the correct tag convention (with a full Framework version)

##### COMP

###### FEM_MDL_COMP

Instance id: | FXE_DET_LPD1M-1/COMP/FEM_MDL_COMP
Class id: | LpdComposite
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, Detector Configuration, Power Overview, LPD Overview, LPD Overview, FEM Overview, Detector Configuration
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- deviceNames:
    The LpdFem devices to be sub-control
- connectFem:
    Open connection to FEM.
- disconnectFem:
    Close connection to FEM.
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device and all fems in case of an error
- sync_params:
    Sets all composite parameters on fems.
- manual_recover:
    Try recovery from UNKNOWN after state desynchronization has been manually solved for the respective children.
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- integrationCycles:
    Sets the number of integration cycles per images
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- numberImages:
    Sets the number of images per trigger
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### MAIN_CNTRL

Instance id: | FXE_DET_LPD1M-1/COMP/MAIN_CNTRL
Class id: | LPDMainControl
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdMiddleLayer
Last modified: | 2021-03-17T20:30:11.000+01:00
Created at: | 2017-02-02T14:07:38.000+01:00
Main authors: | Hauf, Haufs, Degon
Latest tag: | 1.2.2-2.11.0
Deployment tag: | 1.2.2-2.11.0
Scenes: | Power Overview, LPD Overview, Detector Configuration, DOC_TROUBLESHOOT
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD MiddleLayer Tools

Documentation about the available middlelayer tools for LPD 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
- proxyCACML:
    The Clock and Control device
- fem:
    Device controlling Fem, can be composite or one single fem device.
- ccMon:
    CCMon device
- data_taking:
    Detector Device That Implements TakeData Function.
- x2Timer:
    The utca device
- cancel:
    Cancels last command.
- reset:
    Reset from error state.
- femBootUpTime:
    Time needed for FEM to be responsive after powering up [s].
- asicBootUpTime:
    Time needed for asics to follow last commands [s].
- powerTimeout:
    Time needed for power to arrive at all FEMS [s].
- configTimeout:
    Time needed for femComposit to upload config
- scenarioConfig:
    Configuration of common operation scenarios
- emergencyShutdown:
    Power off quadrants immediately.
- uploadConfig:
    Sends selected configuration to detector.
- getReady:
    Bring detector in a state ready for data taking
- start:
    Start DAQ & set the fast_data
- stop:
    Stop DAQ & set the fast_data
- startDisablePower:
    Disable LPDpower & …

Release History
1.2.2-2.11.0

Created: | 2021-03-08T14:31:35.000+01:00
Author: | Alessandro Silenzi
Notes: | tagged after compatibility with python 3.8 was implemented. This tag is backward compatible with karabo 2.10. No changes in the framework

1.2.1-2.10.0

Created: | 2020-11-24T08:16:19.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-06-07T11:16:14.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.2.4

Created: | 2019-04-23T13:19:29.000+02:00
Author: | Steffen Hauf
Notes: | Include CI pause functionality

1.1.8-2.2.4

Created: | 2019-04-01T10:53:58.000+02:00
Author: | Astrid Muennich
Notes: |

1.1.7-2.2.4

Created: | 2018-10-11T13:52:45.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.6-2.2.3

Created: | 2018-06-29T11:08:56.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.5-2.2.1

Created: | 2018-04-13T10:17:47.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.4-12.4.18

Created: | 2018-04-11T15:23:10.000+02:00
Author: | Qing Tian
Notes: | take dark frames in auto mode

1.1.4-2.2.1

Created: | 2018-01-19T11:12:01.000+01:00
Author: | Dennis Goeries
Notes: | Same tag as 1.1.4-12.1.18, but with correct Karabo version

1.1.3-2.1.18

Created: | 2018-01-19T11:12:01.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.2-2.1.18

Created: | 2017-12-14T15:57:44.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.1-2.1.18

Created: | 2017-11-28T12:27:40.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.1.18

Created: | 2017-11-24T14:00:58.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.9-2.1.18

Created: | 2017-11-22T15:50:29.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2017-11-21T10:42:58.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.7-2.1.18

Created: | 2017-11-13T15:04:23.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.6-2.1.15

Created: | 2017-10-19T14:52:14.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.15

Created: | 2017-10-18T17:20:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-17T15:32:58.000+02:00
Author: | Dennis Goeries
Notes: |

##### FPGA

###### FEM_Q1M1

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q1M1
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, FemTemp Monitor, Power Q1M1, Temperature Q1, Power Overview, LPD Overview, LPD Overview, FEM Overview, Temperature Q1, FemTemp Monitor, Detector Configuration, Power Q1M1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q1M2

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q1M2
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, FemTemp Monitor, Power Q1M2, Temperature Q1, Power Overview, Power Q1M2, LPD Overview, LPD Overview, FEM Overview, Temperature Q1, FemTemp Monitor, Detector Configuration
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q1M3

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q1M3
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, FemTemp Monitor, Power Q1M3, Temperature Q1, Power Overview, Power Q1M3, LPD Overview, LPD Overview, FEM Overview, Temperature Q1, FemTemp Monitor, Detector Configuration
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q1M4

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q1M4
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, FemTemp Monitor, Power Q1M4, Temperature Q1, Power Overview, Power Q1M4, LPD Overview, LPD Overview, FEM Overview, Temperature Q1, FemTemp Monitor, Detector Configuration
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q2M1

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q2M1
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Temperature Q2, Power Overview, FemTemp Monitor, Power Q2M1, Power Overview, LPD Overview, LPD Overview, FEM Overview, Temperature Q2, FemTemp Monitor, Detector Configuration, Power Q2M1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q2M2

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q2M2
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Temperature Q2, Power Overview, FemTemp Monitor, Power Q2M2, Power Overview, Power Q2M2, LPD Overview, LPD Overview, FEM Overview, Temperature Q2, FemTemp Monitor, Detector Configuration
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q2M3

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q2M3
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Temperature Q2, Power Overview, FemTemp Monitor, Power Q2M3, Power Overview, Power Q2M3, LPD Overview, LPD Overview, FEM Overview, Temperature Q2, FemTemp Monitor, Detector Configuration
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q2M4

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q2M4
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Temperature Q2, Power Overview, FemTemp Monitor, Power Q2M4, Power Overview, LPD Overview, LPD Overview, FEM Overview, Temperature Q2, FemTemp Monitor, Detector Configuration, Power Q2M4, Q2M4 Investigation
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q3M1

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q3M1
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, FemTemp Monitor, Power Q3M1, Temperature Q3, Power Overview, Power Q3M1, LPD Overview, LPD Overview, FEM Overview, FemTemp Monitor, Detector Configuration, Temperature Q3
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q3M2

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q3M2
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, FemTemp Monitor, Power Q3M2, Temperature Q3, Power Overview, Power Q3M2, LPD Overview, LPD Overview, FEM Overview, FemTemp Monitor, Detector Configuration, Temperature Q3
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q3M3

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q3M3
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, FemTemp Monitor, Power Q3M3, Power Q3M3, Temperature Q3, Power Overview, LPD Overview, LPD Overview, FEM Overview, FemTemp Monitor, Detector Configuration, Temperature Q3
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q3M4

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q3M4
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, FemTemp Monitor, Power Q3M4, Power Overview, LPD Overview, LPD Overview, FEM Overview, FemTemp Monitor, Detector Configuration, Power Q3M4
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q4M1

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q4M1
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Temperature Q4, Power Overview, FemTemp Monitor, Power Q4M1, Power Overview, Power Q4M1, LPD Overview, LPD Overview, FEM Overview, Temperature Q4, FemTemp Monitor, Detector Configuration
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q4M2

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q4M2
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Temperature Q4, Power Overview, FemTemp Monitor, Power Q4M2, Power Overview, LPD Overview, LPD Overview, FEM Overview, Temperature Q4, FemTemp Monitor, Detector Configuration, Power Q4M2
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q4M3

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q4M3
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | Power Q4M3, FEM Overview, Temperature Q4, Power Overview, FemTemp Monitor, Power Q4M3, Power Overview, LPD Overview, LPD Overview, FEM Overview, Temperature Q4, FemTemp Monitor, Detector Configuration
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

###### FEM_Q4M4

Instance id: | FXE_DET_LPD1M-1/FPGA/FEM_Q4M4
Class id: | LpdFem
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdFem
Last modified: | 2021-03-17T20:27:36.000+01:00
Created at: | 2017-02-01T10:12:34.000+01:00
Main authors: | Hauf, Ahmed, Silenzi
Latest tag: | 2.3.4-2.11.0
Deployment tag: | 2.3.4-2.11.0
Installed tag: | 2.3.3-2.10.0
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Temperature Q4, Power Overview, FemTemp Monitor, Power Q4M4, Temperature Q3, Power Overview, Power Q4M4, LPD Overview, LPD Overview, FEM Overview, Temperature Q4, FemTemp Monitor, Detector Configuration, Temperature Q3
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.3.3-2.10.0) does not match tags mentioned in the deployment ([‘2.3.4-2.11.0’])!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Module Control

Documentation about the devices for the control of the LPD modules 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
- connectFem:
    Open connection to FEM
- disconnectFem:
    Close connection to FEM
- configure:
    Upload configuration parameters to the FEM
- prepare:
    Prepare new configuration parameters for the FEM
- startDAQ:
    Start data acquisition
- stopDAQ:
    Stop acquisition immediately
- reset:
    Resets the device in case of an error
- disable:
    Disable FEM to be ignored
- enable:
    Enable FEM to be part of the system
- disabled:
    Disable FEM, will no longer be controlled by the composite
- sys_status:
    Status summary
- error_msg:
    Error message.
- sync_start_time:
    Unix timestamp to trigger start at
- femHost:
    FEM hostname or IP address
- femPort:
    FEM port number
- femTimeout:
    FEM connection timeout
- femAsicModuleType:
    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone
- femLegacyPowerCard:
    Enable legacy power card support
- sensorBias0:
    Sensor 0 HV Bias Voltage [V]
- sensorBias1:
    Sensor 1 HV Bias Voltage [V]
- sensorBiasEnable0:
    Sensor 0 HV Bias Enable
- sensorBiasEnable1:
    Sensor 1 HV Bias Enable
- asicPowerEnable0:
    ASIC 0 LV Power Enable
- asicPowerEnable1:
    ASIC 1 LV Power Enable
- tenGig0SourceMac:
    10GigE 0 UDP Source MAC Address
- tenGig0SourceIp:
    10GigE 0 UDP Source IP Address
- tenGig0SourcePort:
    10GigE 0 UDP Source Port
- tenGig0DestMac:
    10GigE 0 UDP Destination MAC Address
- tenGig0DestIp:
    10GigE 0 UDP Destination IP Address
- tenGig0DestPort:
    10GigE 0 UDP Destination Port
- tenGigInterframeGap:
    10GigE Inter-frame gap timer [clock cycles]
- tenGigUdpPacketLen:
    10GigE UDP packet payload length
- femEnableTenGig:
    Enables transmission of image data via 10GigE UDP interface
- femDataSource:
    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)
- femAsicEnableMask:
    ASIC RX channel enable mask (4*32 bits)
- numberImages:
    Sets the number of images per trigger
- integrationCycles:
    Sets the number of integration cycles per images
- femAsicGain:
    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)
- femAsicSetupParams:
    ASIC Setup Parameters defined in XML syntax
- femAsicCmdSequence:
    ASIC Command Words defined in XML syntax
- femAsicPixelFeedbackOverride:
    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides
- femAsicPixelSelfTestOverride:
    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides
- femReadoutOperatingMode:
    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD
- femAsicDataType:
    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom
- femAsicLocalClock:
    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)
- femAsicSetupLoadMode:
    ASIC control load mode 0=parallel, 1=daisy chain (being tested)
- femInvertAdcData:
    Enable Invert ADC ASIC data True=Invert Data
- femAsicRxCmdWordStart:
    Enable ASIC readout started by Command Word in femAsicCmdSequence file
- femAsicSetupClockPhase:
    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset
- femPpcMode:
    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout
- numberTrains:
    Number of trains [if LL Data Generator or PPC Data Direct selected]
- tenGigFarmMode:
    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists
- femAsicVersion:
    ASIC Version 1=version 1, 2=version 2
- femAsicClockSource:
    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond
- femStartTrainSource:
    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond
- femStartTrainDelay:
    Delay between trigger arrival and start of train (in FEM clock cycles)
- femStartTrainInhibit:
    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout
- femAsicGainOverride:
    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)
- femDebugLevel:
    Set the debug level
- tenGig0DataGenerator:
    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0DataFormat:
    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0FrameLength:
    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]
- tenGig0NumberOfFrames:
    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]
- femStartTrainPolarity:
    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal
- femVetoPolarity:
    Set polarity of the external veto signal 0=No inversion, 1=Invert signal
- femModuleId:
    ID for FEM to differentiate from which FEM data is coming from 0 - 15
- cccSystemMode:
    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes
- cccEmulationMode:
    Enable to emulate Clock & Control commands (for testing in absence of C&C)
- cccProvideNumberImages:
    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages
- cccVetoStartDelay:
    Adjust timing of veto arrival (in steps of clock cycles)
- cccStopDelay:
    Adjust timing of the stop (in steps of clock cycles)
- cccResetDelay:
    Adjust timing of reset (in steps of clock cycles)
- cccVetoPatternFile:
    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)
- trainGenInterval:
    Interval (in 100 mhz clock periods) between internally generated Train start commands
- femAsicTestDataPatternType:
    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image
- femPpcEmulatePipeline:
    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors
- femPpcImageReordering:
    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled
- femTrainIdInitLsw:
    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker
- femTrainIdInitMsw:
    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker
- timeoutTrain:
    Timeout in seconds on waiting for next Train during run
- numPulsesInTrainOverride:
    Length of XRay Pulse Train (number pulses)
- femAsicCommandLength:
    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz
- asicRxGainAlgorithmType:
    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)
- asicRxGainThresholdx100:
    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- asicRxGainThresholdx10:
    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1
- powerCardFault0:
    Power Card 0 Fault Flag
- powerCardFault1:
    Power Card 1 Fault Flag
- powerCardFemStatus0:
    Power Card 0 FEM Status Flag
- powerCardFemStatus1:
    Power Card 1 FEM Status Flag
- powerCardExtStatus0:
    Power Card 0 External Status Flag
- powerCardExtStatus1:
    Power Card 1 External Status Flag
- powerCardOverCurrent0:
    Power Card 0 Overcurrent Flag
- powerCardOverCurrent1:
    Power Card 1 Overcurrent Flag
- powerCardOverTemp0:
    Power Card Over 0 Temperature Flag
- powerCardOverTemp1:
    Power Card Over 1 Temperature Flag
- powerCardUnderTemp0:
    Power Card Under 0 Temperature Flag
- powerCardUnderTemp1:
    Power Card Under 1 Temperature Flag
- powerCardTemp0:
    Power Card 0 Temperature [C]
- powerCardTemp1:
    Power Card 1 Temperature [C]
- sensor0Temp:
    Sensor 0 Temperature [C]
- sensor1Temp:
    Sensor 1 Temperature [C]
- sensor2Temp:
    Sensor 2 Temperature [C]
- sensor3Temp:
    Sensor 3 Temperature [C]
- sensor4Temp:
    Sensor 4 Temperature [C]
- sensor5Temp:
    Sensor 5 Temperature [C]
- sensor6Temp:
    Sensor 6 Temperature [C]
- sensor7Temp:
    Sensor 7 Temperature [C]
- sensor8Temp:
    Sensor 8 Temperature [C]
- sensor9Temp:
    Sensor 9 Temperature [C]
- sensor10Temp:
    Sensor 10 Temperature [C]
- sensor11Temp:
    Sensor 11 Temperature [C]
- sensor12Temp:
    Sensor 12 Temperature [C]
- sensor13Temp:
    Sensor 13 Temperature [C]
- sensor14Temp:
    Sensor 14 Temperature [C]
- sensor15Temp:
    Sensor 15 Temperature [C]
- femVoltage0:
    FEM 5V Supply 0 Voltage [V]
- femVoltage1:
    FEM 5V Supply 1 Voltage [V]
- femCurrent0:
    FEM 5V Supply 0 Current [A]
- femCurrent1:
    FEM 5V Supply 1 Current [A]
- digitalVoltage0:
    ASIC 1.2V Digital Supply 0 Voltage [V]
- digitalVoltage1:
    ASIC 1.2V Digital Supply 1 Voltage [V]
- digitalCurrent0:
    ASIC 1.2V Digital Supply 0 Current [mA]
- digitalCurrent1:
    ASIC 1.2V Digital Supply 1 Current [mA]
- sensor0Voltage:
    Sensor 0 3.3V Supply Voltage [V]
- sensor1Voltage:
    Sensor 1 3.3V Supply Voltage [V]
- sensor2Voltage:
    Sensor 2 3.3V Supply Voltage [V]
- sensor3Voltage:
    Sensor 3 3.3V Supply Voltage [V]
- sensor4Voltage:
    Sensor 4 3.3V Supply Voltage [V]
- sensor5Voltage:
    Sensor 5 3.3V Supply Voltage [V]
- sensor6Voltage:
    Sensor 6 3.3V Supply Voltage [V]
- sensor7Voltage:
    Sensor 7 3.3V Supply Voltage [V]
- sensor8Voltage:
    Sensor 8 3.3V Supply Voltage [V]
- sensor9Voltage:
    Sensor 9 3.3V Supply Voltage [V]
- sensor10Voltage:
    Sensor 10 3.3V Supply Voltage [V]
- sensor11Voltage:
    Sensor 11 3.3V Supply Voltage [V]
- sensor12Voltage:
    Sensor 12 3.3V Supply Voltage [V]
- sensor13Voltage:
    Sensor 13 3.3V Supply Voltage [V]
- sensor14Voltage:
    Sensor 14 3.3V Supply Voltage [V]
- sensor15Voltage:
    Sensor 15 3.3V Supply Voltage [V]
- sensor0Current:
    Sensor 0 3.3V Supply Current [A]
- sensor1Current:
    Sensor 1 3.3V Supply Current [A]
- sensor2Current:
    Sensor 2 3.3V Supply Current [A]
- sensor3Current:
    Sensor 3 3.3V Supply Current [A]
- sensor4Current:
    Sensor 4 3.3V Supply Current [A]
- sensor5Current:
    Sensor 5 3.3V Supply Current [A]
- sensor6Current:
    Sensor 6 3.3V Supply Current [A]
- sensor7Current:
    Sensor 7 3.3V Supply Current [A]
- sensor8Current:
    Sensor 8 3.3V Supply Current [A]
- sensor9Current:
    Sensor 9 3.3V Supply Current [A]
- sensor10Current:
    Sensor 10 3.3V Supply Current [A]
- sensor11Current:
    Sensor 11 3.3V Supply Current [A]
- sensor12Current:
    Sensor 12 3.3V Supply Current [A]
- sensor13Current:
    Sensor 13 3.3V Supply Current [A]
- sensor14Current:
    Sensor 14 3.3V Supply Current [A]
- sensor15Current:
    Sensor 15 3.3V Supply Current [A]
- sensorBiasVoltage0:
    Sensor bias 0 voltage readback [V]
- sensorBiasVoltage1:
    Sensor bias 1 voltage readback [V]
- sensorBiasCurrent0:
    Sensor bias 0 current readback [uA]
- sensorBiasCurrent1:
    Sensor bias 1 current readback [uA]
- femV5FirmwareVersion:
    FEM V5 Firmware Version
- femBotSp3FirmwareVersion:
    FEM Bottom SP3 FPGA Firmware Version
- femTopSp3FirmwareVersion:
    FEM Top SP3 FPGA Firmware Version
- femCfgSp3FirmwareVersion:
    FEM Config SP3 FPGA Firmware Version
- femLpdClientVersion:
    LpdFemClient Software Version - Read Only
- femReadoutActive:
    FEM readout is active
- femBoardTemperature:
    FEM Board Sensor Temperature [C] Reading
- femCoreTemperature:
    FEM Core Sensor Temperature [C] Reading

Release History
2.3.4-2.11.0

Created: | 2021-03-10T06:59:32.000+01:00
Author: | Alessandro Silenzi
Notes: | Tagged after the refactoring to match python 3.8 syntax

2.3.3-2.9.1

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | Added proper classVersion info, CI and tests for instantiation.

2.3.3-2.10.0

Created: | 2020-09-15T16:14:34.000+02:00
Author: | Istvan Mohacsi
Notes: | To signify 2.10 compatibility

2.3.2-2.6.5

Created: | 2020-01-28T11:49:27.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.6.5

Created: | 2019-12-17T14:07:44.000+01:00
Author: | Steffen Hauf
Notes: |

2.3.0-2.4.0

Created: | 2019-04-15T14:54:51.000+02:00
Author: | Astrid Muennich
Notes: | Refactored Polling, triggered by ERROR state appearing on DISABLED FEM.

2.2.0-2.3.0

Created: | 2018-11-13T13:54:26.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.1.15

Created: | 2018-02-01T17:03:04.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.8-2.1.15

Created: | 2018-01-12T13:58:18.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.15

Created: | 2017-11-28T15:57:57.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.15

Created: | 2017-11-28T12:18:15.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.15

Created: | 2017-11-27T16:04:40.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.15

Created: | 2017-11-22T14:50:27.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.15

Created: | 2017-10-11T17:37:18.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1.15

Created: | 2017-08-30T11:12:31.000+02:00
Author: | Astrid Muennich
Notes: |

2.0.1-2.1.12

Created: | 2017-08-18T09:57:47.000+02:00
Author: | Astrid Muennich
Notes: | fix for sync start

2.0.0-2.1.12

Created: | 2017-08-09T16:00:28.000+02:00
Author: | John Wiggins
Notes: | Tag for 2.1.12 deployment

lpd-to-FXE-Framework-2.1.12

Created: | 2017-06-27T13:48:24.000+02:00
Author: | Steffen Hauf
Notes: |

2.1.6-LPD

Created: | 2017-03-20T12:55:15.000+01:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

tags

Created: | 2014-03-28T16:12:21.000+00:00
Author: | Majank Kumar
Notes: | correcting dir structure of tags/1.0.0

##### MDL

###### CELL_MONITOR

###### LPD General Documentation

A general introduction to the LPD detector can be found here.

##### PRCDR

###### DARKFRAMES

Instance id: | FXE_DET_LPD1M-1/PRCDR/DARKFRAMES
Class id: | LPDDarkFrames
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdMiddleLayer
Last modified: | 2021-03-17T20:30:11.000+01:00
Created at: | 2017-02-02T14:07:38.000+01:00
Main authors: | Hauf, Haufs, Degon
Latest tag: | 1.2.2-2.11.0
Deployment tag: | 1.2.2-2.11.0
Projects: | LPD_Control, DET_LPD
Scenes: | LPD Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

LPD MiddleLayer Tools

Documentation about the available middlelayer tools for LPD can be found here.

LPD General Documentation

A general introduction to the LPD detector 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
- proxyCACML:
    The Clock and Control device
- fem:
    Device controlling Fem, can be composite or one single fem device.
- ccMon:
    CCMon device
- data_taking:
    Detector Device That Implements TakeData Function.
- x2Timer:
    The utca device
- cancel:
    Cancels last button pressed.
- reset:
    Reset from error state.
- auto_mode:
    Configure default configuration when taking darks
- take_dark_frames:
    Take set of dark frames.

Release History
1.2.2-2.11.0

Created: | 2021-03-08T14:31:35.000+01:00
Author: | Alessandro Silenzi
Notes: | tagged after compatibility with python 3.8 was implemented. This tag is backward compatible with karabo 2.10. No changes in the framework

1.2.1-2.10.0

Created: | 2020-11-24T08:16:19.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-06-07T11:16:14.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.2.4

Created: | 2019-04-23T13:19:29.000+02:00
Author: | Steffen Hauf
Notes: | Include CI pause functionality

1.1.8-2.2.4

Created: | 2019-04-01T10:53:58.000+02:00
Author: | Astrid Muennich
Notes: |

1.1.7-2.2.4

Created: | 2018-10-11T13:52:45.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.6-2.2.3

Created: | 2018-06-29T11:08:56.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.5-2.2.1

Created: | 2018-04-13T10:17:47.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.4-12.4.18

Created: | 2018-04-11T15:23:10.000+02:00
Author: | Qing Tian
Notes: | take dark frames in auto mode

1.1.4-2.2.1

Created: | 2018-01-19T11:12:01.000+01:00
Author: | Dennis Goeries
Notes: | Same tag as 1.1.4-12.1.18, but with correct Karabo version

1.1.3-2.1.18

Created: | 2018-01-19T11:12:01.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.2-2.1.18

Created: | 2017-12-14T15:57:44.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.1-2.1.18

Created: | 2017-11-28T12:27:40.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.1.18

Created: | 2017-11-24T14:00:58.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.9-2.1.18

Created: | 2017-11-22T15:50:29.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2017-11-21T10:42:58.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.7-2.1.18

Created: | 2017-11-13T15:04:23.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.6-2.1.15

Created: | 2017-10-19T14:52:14.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.15

Created: | 2017-10-18T17:20:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-17T15:32:58.000+02:00
Author: | Dennis Goeries
Notes: |

###### DELAYSCAN

LPD MiddleLayer Tools

Documentation about the available middlelayer tools for LPD can be found here.

LPD General Documentation

A general introduction to the LPD detector can be found here.

###### TAKEDATA

Instance id: | FXE_DET_LPD1M-1/PRCDR/TAKEDATA
Class id: | TakeDataLPD
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdMiddleLayer
Last modified: | 2021-03-17T20:30:11.000+01:00
Created at: | 2017-02-02T14:07:38.000+01:00
Main authors: | Hauf, Haufs, Degon
Latest tag: | 1.2.2-2.11.0
Deployment tag: | 1.2.2-2.11.0
Projects: | LPD_Control, DET_LPD
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

LPD MiddleLayer Tools

Documentation about the available middlelayer tools for LPD can be found here.

LPD General Documentation

A general introduction to the LPD detector 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
- fem:
    Device controlling Fem, can be composite
- runControl:
    Device controlling run management.
- ccMon:
    Device controlling clock & control.
- cancel:
    Cancels last button pressed.
- reset:
    Recover from UNKNOWN state to ON state
- self_check:
    Check if all conditions are ok for data taking.

Release History
1.2.2-2.11.0

Created: | 2021-03-08T14:31:35.000+01:00
Author: | Alessandro Silenzi
Notes: | tagged after compatibility with python 3.8 was implemented. This tag is backward compatible with karabo 2.10. No changes in the framework

1.2.1-2.10.0

Created: | 2020-11-24T08:16:19.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-06-07T11:16:14.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.2.4

Created: | 2019-04-23T13:19:29.000+02:00
Author: | Steffen Hauf
Notes: | Include CI pause functionality

1.1.8-2.2.4

Created: | 2019-04-01T10:53:58.000+02:00
Author: | Astrid Muennich
Notes: |

1.1.7-2.2.4

Created: | 2018-10-11T13:52:45.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.6-2.2.3

Created: | 2018-06-29T11:08:56.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.5-2.2.1

Created: | 2018-04-13T10:17:47.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.4-12.4.18

Created: | 2018-04-11T15:23:10.000+02:00
Author: | Qing Tian
Notes: | take dark frames in auto mode

1.1.4-2.2.1

Created: | 2018-01-19T11:12:01.000+01:00
Author: | Dennis Goeries
Notes: | Same tag as 1.1.4-12.1.18, but with correct Karabo version

1.1.3-2.1.18

Created: | 2018-01-19T11:12:01.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.2-2.1.18

Created: | 2017-12-14T15:57:44.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.1-2.1.18

Created: | 2017-11-28T12:27:40.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.1.18

Created: | 2017-11-24T14:00:58.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.9-2.1.18

Created: | 2017-11-22T15:50:29.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2017-11-21T10:42:58.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.7-2.1.18

Created: | 2017-11-13T15:04:23.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.6-2.1.15

Created: | 2017-10-19T14:52:14.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.15

Created: | 2017-10-18T17:20:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-17T15:32:58.000+02:00
Author: | Dennis Goeries
Notes: |

##### PSC

###### PSCU

Instance id: | FXE_DET_LPD1M-1/PSC/PSCU
Class id: | LpdPower
Host: | fxe-rr-sys-con-10
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/lpdPower
Last modified: | 2020-11-24T18:49:24.000+01:00
Created at: | 2017-03-01T15:41:42.000+01:00
Main authors: | Haufs, Hauf, Santos
Latest tag: | 1.1.2-2.10.0-hotfix
Deployment tag: | 1.1.2-2.10.0-hotfix
Installed tag: | 1.1.2-2.10.0-hotfix
Projects: | LPD_Control, DET_LPD
Scenes: | FEM Overview, Power Overview, PSCU Overview, Power Overview, LPD Overview, LPD Overview, FEM Overview, PSCU Overview, Detector Configuration, test
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc, yousefh

Warning

Rogue installation which is not mentioned in the deployment!

LPD General Documentation

A general introduction to the LPD detector can be found here.

LPD Power Unit

Documentation about the device controlling the power unit for LPD 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:
    Status of the system wide variables
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- control:
    Control of system variables
- powerEnable:
    Allow all quadrants to receive power.
- powerDisable:
    Forbid all quadrants to receive power.
- armInterlock:
    Arm interlock to be able to power quadrants.
- disarmInterlock:
    Disarm interlock, no power allowed to quadrants.
- reset:
    Recover from UNKNOWN state after en exception.
- quad1:
    Quad1 node
- quad4:
    Quad4 node
- quad2:
    Quad2 node
- quad3:
    Quad3 node
- temperature:
    Temperature sensors
- humidity:
    Humidity sensors
- leakimpedance:
    Leak sensors
- pump:
    Pump variables
- fan:
    Fan variables

Release History
1.1.2-2.10.0-hotfix

Created: | 2020-11-24T17:31:23.000+01:00
Author: | Wajid Ehsan
Notes: | Update Version Info

1.1.1-2.9.1-temp-hotfix

Created: | 2020-06-17T15:30:45.000+02:00
Author: | Steffen Hauf
Notes: |

1.1.0-2.6.5-temp-hotfix

Created: | 2020-06-11T16:09:24.000+02:00
Author: | Steffen Hauf
Notes: | Update LpdPower for temperature and humidity sensor channel naming by Tim Nicholls

1.1.0-2.6.5

Created: | 2019-12-17T14:17:13.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.1-2.2.5

Created: | 2018-11-30T09:29:42.000+01:00
Author: | Steffen Hauf
Notes: |

lpd-to-FXE-Framework-2.1.12

Created: | 2017-05-17T14:50:18.000+02:00
Author: | Hugo Santos
Notes: |

1.0.0-2.1.12

Created: | 2017-05-17T14:50:18.000+02:00
Author: | Hugo Santos
Notes: |

2.1.6-LPD

Created: | 2017-03-28T08:59:08.000+02:00
Author: | Astrid Muennich
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

##### DET

[add component documentation]

###### 0CH0

Instance id: | FXE_DET_LPD1M-1/DET/0CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-0
Alias: | fxe-br-sys-daq-0
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT, LPD_DAQ, DET_LPD
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 10CH0

Instance id: | FXE_DET_LPD1M-1/DET/10CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-10
Alias: | fxe-br-sys-daq-10
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | LPD_DAQ, DET_LPD, FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 11CH0

Instance id: | FXE_DET_LPD1M-1/DET/11CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-11
Alias: | fxe-br-sys-daq-11
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT, LPD_DAQ, DET_LPD
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 12CH0

Instance id: | FXE_DET_LPD1M-1/DET/12CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-12
Alias: | fxe-br-sys-daq-12
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | LPD_DAQ, DET_LPD, FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 13CH0

Instance id: | FXE_DET_LPD1M-1/DET/13CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-13
Alias: | fxe-br-sys-daq-13
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | LPD_DAQ, DET_LPD, FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 14CH0

Instance id: | FXE_DET_LPD1M-1/DET/14CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-14
Alias: | fxe-br-sys-daq-14
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT, LPD_DAQ, DET_LPD
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 15CH0

Instance id: | FXE_DET_LPD1M-1/DET/15CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-15
Alias: | fxe-br-sys-daq-15
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT, LPD_DAQ, DET_LPD
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 6CH0

Instance id: | FXE_DET_LPD1M-1/DET/6CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-6
Alias: | fxe-br-sys-daq-6
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT, LPD_DAQ, DET_LPD
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 7CH0

Instance id: | FXE_DET_LPD1M-1/DET/7CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-7
Alias: | fxe-br-sys-daq-7
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT, LPD_DAQ, DET_LPD
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 8CH0

Instance id: | FXE_DET_LPD1M-1/DET/8CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-8
Alias: | fxe-br-sys-daq-8
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT, LPD_DAQ, DET_LPD
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 9CH0

Instance id: | FXE_DET_LPD1M-1/DET/9CH0
Class id: | DataAggregator
Host: | fxe-br-sys-daq-9
Alias: | fxe-br-sys-daq-9
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | LPD_DAQ, DET_LPD, FXETST_DAQ_LPD, FXETST_DAQ_RUN_MANAGEMENT
Scenes: | DAQ Status, LPD_DAQ_V2, DAQ_CONFIG_SERVICE, FXE_DAQ_Status, FXE_DAQ_STATUS-OBSOLETE, CAL_MANAGER_old, CAL_MANAGER, MONITORING_LPD_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

LPD General Documentation

A general introduction to the LPD detector 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
- 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: |

##### ZMQ

[add component documentation]

###### APPEND_CORR

Instance id: | FXE_DET_LPD1M-1/ZMQ/APPEND_CORR
Class id: | PipeToZeroMQ
Host: | sa1-br-kc-comp-3
Alias: | sa1-br-kc-comp-3
Git repo: | https://git.xfel.eu/karaboDevices/PipeToZeroMQ
Last modified: | 2021-08-05T13:42:03.000+02:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Haufs, Dall’antonia, Michelat
Latest tag: | 3.2.6-2.11.0
Deployment tag: | 3.2.6-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

LPD General Documentation

A general introduction to the LPD detector 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
- 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.6-2.11.0

Created: | 2021-08-05T13:41:59.000+02:00
Author: | Thomas Michelat
Notes: | Schema update compatible with karabo 2.11

3.2.5-2.11.0hotfix1

Created: | 2021-07-20T11:35:08.000+02:00
Author: | Riccardo Fabbri
Notes: |

3.2.5-2.10.0

Created: | 2020-11-26T13:52:59.000+01:00
Author: | Thomas Michelat
Notes: | Add Karabo 2.10 Versioning Info

3.2.4-2.10.0

Created: | 2020-11-18T11:03:59.000+01:00
Author: | Thomas Michelat
Notes: | Karabo 2.10 compatibility: now validate the schema of tables.

3.2.3-2.9.0

Created: | 2020-11-05T18:59:22.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.2.2-2.9.0

Created: | 2020-11-05T17:23:38.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.2.1-2.9.0

Created: | 2020-11-05T12:23:45.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.1.1-2.9.0

Created: | 2020-06-03T10:31:31.000+02:00
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

3.0.1-2.7.1

Created: | 2020-03-09T17:39:08.000+01:00
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-17T19:11:31.000+01:00
Author: | Thomas Michelat
Notes: |

2.5.3-2.6.4

Created: | 2019-11-21T13:49:39.000+01:00
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T15:07:41.000+02:00
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T15:24:28.000+02:00
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T13:22:48.000+02:00
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T17:15:49.000+02:00
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T14:24:56.000+01:00
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-06T16:04:31.000+01:00
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T17:29:01.000+02:00
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-14T18:48:15.000+02:00
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-05T18:55:54.000+02:00
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

##### TRAINMATCHER

[add component documentation]

###### LPD_NORM

Instance id: | FXE_DET_LPD1M-1/TRAINMATCHER/LPD_NORM
Class id: | TrainMatcher
Host: | sa1-br-kc-comp-3
Alias: | sa1-br-kc-comp-3
Git repo: | https://git.xfel.eu/karaboDevices/TrainMatcher
Last modified: | 2021-09-03T19:27:49.175+02:00
Created at: | 2018-04-25T15:34:20.000+02:00
Main authors: | Fabbri, Haufs, Schmidt
Latest tag: | 1.2.0-2.10.2
Deployment tag: | 1.2.0-2.10.2
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

LPD General Documentation

A general introduction to the LPD detector 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
- channels:
    list output channel to monitor.
- fastSources:
    Data sources names and configuration from connected output channels
- slowSources:
    Device properties to monitor
- mode:
    operation mode, “match”: match all selected fast sources, “buffer”: send (selected) sources that arrived when the buffer reached the limit
- output:
    Output channel for combined train data.
- received:
    Count how many trains were received.
- sent:
    Count how many train data were sent.
- matchingRatio:
    Exponential moving average of the relation between sent and received trains.
- trainId:
    the last trainId data that matched.
- buffer:
    Length of buffer to hold non-complete trains in.
- delay:
    delay applied before sending data on output channel (in #trains)
- offsetTid:
    If this property is True, it will change the value of the trainId in the metadata for the data sources having an offset value different from 0. The trainId value assigned will be the “matched” trainId, i.e. trainId + offset for the source.

Release History
1.2.0-2.10.2

Created: | 2021-03-26T15:34:34.000+01:00
Author: | Thomas Michelat
Notes: | Add “buffer” mode

1.1.0-2.10.2

Created: | 2021-03-24T14:37:27.000+01:00
Author: | Thomas Michelat
Notes: | option to overwrite trainid in metadata if data source is shifted

1.0.1-2.10.0

Created: | 2020-12-02T17:50:00.000+01:00
Author: | Valerii Bondar
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.0.0-2.7.1

Created: | 2020-02-18T14:21:57.000+01:00
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-27T09:48:16.000+02:00
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-13T16:44:05.000+02:00
Author: | Thomas Michelat
Notes: |

0.2.0b1-2.4.0

Created: | 2019-05-03T15:40:27.000+02:00
Author: | Thomas Michelat
Notes: | simple slow data monitoring, bulked property updates

1.0.0b1-2.4.0

Created: | 2019-03-18T19:50:21.000+01:00
Author: | Ebad Kamil
Notes: | first “real” try of monitoring slow data (will change)

0.1.0-2.4.0

Created: | 2018-04-27T14:01:19.000+02:00
Author: | Thomas Michelat
Notes: |

#### MOV

##### ENC

###### X

Instance id: | FXE_DET_MOV/ENC/X
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_DET_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### Y

Instance id: | FXE_DET_MOV/ENC/Y
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_DET_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### Z

Instance id: | FXE_DET_MOV/ENC/Z
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_DET_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### X

###### Y

###### Z

#### LPD1M

[add component documentation]

##### MDL

[add component documentation]

###### TAKE_DATA_CI

Instance id: | FXE_DET_LPD1M/MDL/TAKE_DATA_CI
Host: | exflcon52n0
Alias: | fxe-rr-sys-con-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/lpdMiddleLayer
Last modified: | 2020-04-17T10:50:52.000+02:00
Created at: | 2017-02-02T14:07:38.000+01:00
Main authors: | Hauf, Degon, Muennich
Latest tag: | 1.2.1-2.4.1
Deployment tag: | 1.2.1-2.4.1
Accessible by: | CAL, CONTROLS, DA, DET

Warning

Installation not found in a standard path!

LPD General Documentation

A general introduction to the LPD detector can be found here.

Release History
1.2.1-2.4.1

Created: | 2019-06-07T09:16:14.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.2.4

Created: | 2019-04-23T11:19:29.000Z
Author: | Steffen Hauf
Notes: | Include CI pause functionality

1.1.8-2.2.4

Created: | 2019-04-01T08:53:58.000Z
Author: | Astrid Muennich
Notes: |

1.1.7-2.2.4

Created: | 2018-10-11T11:52:45.000Z
Author: | Steffen Hauf
Notes: |

1.1.6-2.2.3

Created: | 2018-06-29T09:08:56.000Z
Author: | Steffen Hauf
Notes: |

1.1.5-2.2.1

Created: | 2018-04-13T08:17:47.000Z
Author: | Steffen Hauf
Notes: |

1.1.4-12.4.18

Created: | 2018-04-11T13:23:10.000Z
Author: | Qing Tian
Notes: | take dark frames in auto mode

1.1.4-2.2.1

Created: | 2018-01-19T10:12:01.000Z
Author: | Dennis Goeries
Notes: | Same tag as 1.1.4-12.1.18, but with correct Karabo version

1.1.3-2.1.18

Created: | 2018-01-19T10:12:01.000Z
Author: | Dennis Goeries
Notes: |

1.1.2-2.1.18

Created: | 2017-12-14T14:57:44.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.1.18

Created: | 2017-11-28T11:27:40.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.1.18

Created: | 2017-11-24T13:00:58.000Z
Author: | Dennis Goeries
Notes: |

1.0.9-2.1.18

Created: | 2017-11-22T14:50:29.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2017-11-21T09:42:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.7-2.1.18

Created: | 2017-11-13T14:04:23.000Z
Author: | Steffen Hauf
Notes: |

1.0.6-2.1.15

Created: | 2017-10-19T12:52:14.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.15

Created: | 2017-10-18T15:20:18.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-17T13:32:58.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-08-30T09:10:13.000Z
Author: | Astrid Muennich
Notes: |

1.0.2-2.1.12

Created: | 2017-08-18T07:57:58.000Z
Author: | Astrid Muennich
Notes: | fixes and cleanup

### LAS

#### USR

##### MOTOR

###### DELAY_1

Instance id: | FXE_LAS_USR/MOTOR/DELAY_1
Host: | exflcon51n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### DELAY_2

Instance id: | FXE_LAS_USR/MOTOR/DELAY_2
Host: | exflcon51n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

### OGT1

#### ATT

##### ENC

###### ROD1_IN_OUT

Instance id: | FXE_OGT1_ATT/ENC/ROD1_IN_OUT
Host: | exflcon06n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
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.9-2.6.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### ROD2_IN_OUT

Instance id: | FXE_OGT1_ATT/ENC/ROD2_IN_OUT
Host: | exflcon06n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
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.9-2.6.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### ROD3_IN_OUT

Instance id: | FXE_OGT1_ATT/ENC/ROD3_IN_OUT
Host: | exflcon06n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
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.9-2.6.1
Projects: | FXE_OGT1_ATT, FXE_LOOP2, FXE_OGT1_ATT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### ROD4_IN_OUT

Instance id: | FXE_OGT1_ATT/ENC/ROD4_IN_OUT
Host: | exflcon06n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
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.9-2.6.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MDL

###### MAIN

Instance id: | FXE_OGT1_ATT/MDL/MAIN
Class id: | JJAttenuator
Host: | fxe-rr-sys-con-2
Class documentation:
| JJAttenuator
Alias: | fxe-rr-sys-con-2
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: | FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT_MAIN, IntensityScan_toDelete0604, IntensityScan2
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

###### ROD1_IN_OUT

###### ROD2_IN_OUT

###### ROD3_IN_OUT

###### ROD4_IN_OUT

###### CHAM_X

##### TSENS

###### B4C_TEMP1

Instance id: | FXE_OGT1_ATT/TSENS/B4C_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_LOOP2, FXE_OGT1_ATT
Scenes: | FXE_OGT1_ATT/TSENS/B4C_TEMP1, FXE_OGT1_ATT/TSENS/B4C_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### B4C_TEMP2

Instance id: | FXE_OGT1_ATT/TSENS/B4C_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Scenes: | FXE_OGT1_ATT/TSENS/B4C_TEMP2, FXE_OGT1_ATT/TSENS/B4C_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD1_TEMP1

Instance id: | FXE_OGT1_ATT/TSENS/ROD1_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Scenes: | FXE_OGT1_ATT/TSENS/ROD1_TEMP1, FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT/TSENS/ROD1_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD1_TEMP2

Instance id: | FXE_OGT1_ATT/TSENS/ROD1_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Scenes: | FXE_OGT1_ATT/TSENS/ROD1_TEMP2, FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT/TSENS/ROD1_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD2_TEMP1

Instance id: | FXE_OGT1_ATT/TSENS/ROD2_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_LOOP2, FXE_OGT1_ATT
Scenes: | FXE_OGT1_ATT/TSENS/ROD2_TEMP1, FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT/TSENS/ROD2_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD2_TEMP2

Instance id: | FXE_OGT1_ATT/TSENS/ROD2_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Scenes: | FXE_OGT1_ATT/TSENS/ROD2_TEMP2, FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT/TSENS/ROD2_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD3_TEMP1

Instance id: | FXE_OGT1_ATT/TSENS/ROD3_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Scenes: | FXE_OGT1_ATT/TSENS/ROD3_TEMP1, FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT/TSENS/ROD3_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD3_TEMP2

Instance id: | FXE_OGT1_ATT/TSENS/ROD3_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_LOOP2, FXE_OGT1_ATT
Scenes: | FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT/TSENS/ROD3_TEMP2, FXE_OGT1_ATT/TSENS/ROD3_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD4_TEMP1

Instance id: | FXE_OGT1_ATT/TSENS/ROD4_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_OGT1_ATT, FXE_LOOP2
Scenes: | FXE_OGT1_ATT/TSENS/ROD4_TEMP1, FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT/TSENS/ROD4_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD4_TEMP2

Instance id: | FXE_OGT1_ATT/TSENS/ROD4_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_ATT, FXE_LOOP2, FXE_OGT1_ATT
Scenes: | FXE_OGT1_ATT/TSENS/ROD4_TEMP2, FXE_OGT1_ATT_OVERVIEW, FXE_OGT1_ATT/TSENS/ROD4_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

#### BIU

##### AVG

###### CAMERA

Instance id: | FXE_OGT1_BIU/AVG/CAMERA
Class id: | ImageAverager
Host: | exflcon07n0
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FXE_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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

###### CAMERA

GENICAM CAMERAS

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

##### ENC

###### SCREEN_Y

Instance id: | FXE_OGT1_BIU/ENC/SCREEN_Y
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-07T15:31:28.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
Projects: | FXE_OGT1_BIU, FXE_OGT1_BIU, FXE_LOOP1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

[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

###### MAIN

Instance id: | FXE_OGT1_BIU/MDL/MAIN
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-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: | FXE_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!

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
- moveC:
    Moves the motor to the position marked with this label
- moveC_:
    Moves the motor to the position marked with this label
- moveYAG:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

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

1.3.7-2.11.0

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

1.3.6-2.10.0

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

1.3.6-2.9.1

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

1.3.5-2.4.0

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

1.3.4-2.2.4

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

1.3.3-2.2.4

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

1.3.2-2.2.4

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

1.3.1-2.2.4

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

1.3.0-2.2.4

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

1.2.1-2.2.3

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

1.2.0-2.2.2

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

1.1.0-2.2.0

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

1.0.4-2.1.15

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

1.0.3-2.1.15

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

1.0.2-2.1.14

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

1.0.1-2.1.12

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

1.0.0-2.1.12

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

##### MOTOR

###### SCREEN_Y

##### PROC

###### CAMERA

Instance id: | FXE_OGT1_BIU/PROC/CAMERA
Class id: | ImageProcessor
Host: | exflcon07n0
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-1
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: | BIU_OVERVIEW, FXE_OGT1_BIU_positions_and_projections, FXE_OGT1_BIU-CAM-CAMERA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

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

Device Schema Description

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

Release History
1.27.4-2.10.0

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

1.27.4-2.9.1

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

1.27.3-2.9.1

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

1.27.2-2.9.1

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

1.27.1-2.8.0

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

1.27.0-2.7.0

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

1.26.0-2.7.0

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

1.25.0-2.6.2

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

1.24.3-2.6.1

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

1.24.2-2.6.1

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

1.24.1-2.6.1

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

1.24.0-2.5.1

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

1.23.2-2.5.0

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

1.23.1-2.5.0

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

1.23.0-2.5

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

1.22.0-2.4.2

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

1.21.0-2.4.1

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

1.20.0-2.4.0

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

1.19.0-2.3.7

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

1.18.0-2.3.5

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

##### TSENS

###### ROD_TEMP1

Instance id: | FXE_OGT1_BIU/TSENS/ROD_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_BIU, FXE_OGT1_BIU, FXE_LOOP1
Scenes: | OVERVIEW_SENSORS_LOOP1, FXE_OGT1_BIU/TSENS/ROD_TEMP1, FXE_OGT1_BIU/TSENS/ROD_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### ROD_TEMP2

Instance id: | FXE_OGT1_BIU/TSENS/ROD_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_BIU, FXE_LOOP1, FXE_OGT1_BIU
Scenes: | FXE_OGT1_BIU/TSENS/ROD_TEMP2, FXE_OGT1_BIU/TSENS/ROD_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.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]

###### LED

#### IPM

##### ENC

###### TARGET_IN_OUT

Instance id: | FXE_OGT1_IPM/ENC/TARGET_IN_OUT
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_IPM, FXE_LOOP1, FXE_OGT1_IPM
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MDL

###### MONITOR

Instance id: | FXE_OGT1_IPM/MDL/MONITOR
Class id: | BeamPositionMonitor
Host: | fxe-rr-sys-con-4
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/beamPositionMonitor
Last modified: | 2021-04-13T23:18:59.000+02:00
Created at: | 2018-08-16T18:02:48.000+02:00
Main authors: | Haufs, Wajid, Cas
Latest tag: | 1.7.1-2.10.0
Deployment tag: | 1.7.1-2.10.0
Scenes: | temp_apd_trend, IPM2_overview, DIGI_APD_B1, IPM_overview, FXE_OGT1_IPM/MDL/MONITOR, FXE_OGT1_IPM/MDL/MONITOR, FXE_DIGI_MAIN, FXE_OGT1_IPM-MDL-MONITOR, FXE_OGT1_IPM_MAIN, FXE_IPM_CORR
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
- topChannel:
    Please specify the ADC channel which correspond to Top
- bottomChannel:
    Please specify the ADC channel which correspond to Bottom
- leftChannel:
    Please specify the channel which correspond to Left
- rightChannel:
    Please specify the channel which correspond to Right
- calibrationFactorX:
    Calibration Factor to align beam position in x direction
- calibrationFactorY:
    Calibration Factor to align beam position in y direction
- fetchUpperBound:
    If true the value of upper bound will be computed from digitizer device and will be equal to number of pulses
- upperBound:
    upper range of window to select desired pulses
- lowerBound:
    Lower range of window to select desired pulses
- temporalAverage:
    Average is evaluated over N last Trains
- numberOfPulses:
    Number of pulses per train
- pulseThreshold:
    Threshold to validate the pulse
- trainThreshold:
    Threshold to validate the train
- pulseValidity:
    True, if a value of all channels at a given pulses are greater than pulse threshold otherwise false
- trainValidity:
    True, if pulseValidity of all channels are greater than train threshold otherwise false
- quadrant:
    Quadrant
- scatterPosition:
    Scatter Position Node

Release History
1.7.1-2.10.0

Created: | 2020-11-24T09:49:13.000+01:00
Author: | Wajid Ehsan
Notes: | Update version

1.7.0-2.9.0

Created: | 2020-11-03T15:33:31.000+01:00
Author: | Wajid Ehsan
Notes: | Get the value of the upper bound from the digitizer device.

1.6.0-2.7.0

Created: | 2020-05-04T12:55:53.000+02:00
Author: | Wajid Ehsan
Notes: | Scatter plot for standard deviation

1.5.0-2.7.0

Created: | 2020-03-26T11:11:17.000+01:00
Author: | Wajid Ehsan
Notes: | This device now gets data from digitizerData MDL device. which has different APD channels per board

1.4.1-2.4.0

Created: | 2019-06-07T16:31:10.000+02:00
Author: | Wajid Ehsan
Notes: | include Standard deviation

1.4.0-2.4.0-hotfix

Created: | 2019-06-03T18:11:25.000+02:00
Author: | CAS
Notes: | unset value will give exception

1.4.0-2.4.0

Created: | 2019-05-28T13:12:48.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of APD class

1.3.3-2.4.0

Created: | 2019-05-22T16:55:53.000+02:00
Author: | Wajid Ehsan
Notes: | Include Temporal Standard deviation

1.3.2-2.4.0

Created: | 2019-05-09T17:30:44.000+02:00
Author: | Wajid Ehsan
Notes: | Include Standard deviation

1.3.1-2.3.2

Created: | 2019-03-07T18:34:01.000+01:00
Author: | Wajid Ehsan
Notes: | Take absolute value of APD data for pulse validity

1.3.0-2.3.2

Created: | 2019-03-05T17:56:44.000+01:00
Author: | Wajid Ehsan
Notes: | Pulse and train validity check

1.2.0-2.3.2

Created: | 2019-02-15T17:04:14.000+01:00
Author: | Wajid Ehsan
Notes: | Separate channel for Digitizer APD data

1.1.0-2.2.4

Created: | 2018-12-20T12:31:16.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.1-2.2.4

Created: | 2018-09-17T20:38:32.000+02:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.4

Created: | 2018-09-10T10:17:12.000+02:00
Author: | Wajid Ehsan
Notes: | first version of Beam Position Monitor MDL device

###### MAIN

Instance id: | FXE_OGT1_IPM/MDL/MAIN
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-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: | FXE_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!

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
- moveC1:
    Moves the motor to the position marked with this label
- moveC2:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

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

1.3.7-2.11.0

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

1.3.6-2.10.0

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

1.3.6-2.9.1

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

1.3.5-2.4.0

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

1.3.4-2.2.4

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

1.3.3-2.2.4

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

1.3.2-2.2.4

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

1.3.1-2.2.4

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

1.3.0-2.2.4

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

1.2.1-2.2.3

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

1.2.0-2.2.2

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

1.1.0-2.2.0

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

1.0.4-2.1.15

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

1.0.3-2.1.15

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

1.0.2-2.1.14

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

1.0.1-2.1.12

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

1.0.0-2.1.12

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

##### MOTOR

###### TARGET_IN_OUT

###### AUX1

##### TSENS

###### TEMP1

Instance id: | FXE_OGT1_IPM/TSENS/TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_IPM, FXE_OGT1_IPM, FXE_LOOP1
Scenes: | OVERVIEW_OGT1_IPM, FXE_OGT1_IPM/TSENS/TEMP1, FXE_OGT1_IPM/TSENS/TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TEMP2

Instance id: | FXE_OGT1_IPM/TSENS/TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_IPM, FXE_OGT1_IPM, FXE_LOOP1
Scenes: | OVERVIEW_OGT1_IPM, FXE_OGT1_IPM/TSENS/TEMP2, FXE_OGT1_IPM/TSENS/TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TEMP3

Instance id: | FXE_OGT1_IPM/TSENS/TEMP3
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_IPM, FXE_OGT1_IPM, FXE_LOOP1
Scenes: | OVERVIEW_OGT1_IPM, FXE_OGT1_IPM/TSENS/TEMP3, FXE_OGT1_IPM/TSENS/TEMP3
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TEMP4

Instance id: | FXE_OGT1_IPM/TSENS/TEMP4
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_IPM, FXE_OGT1_IPM, FXE_LOOP1
Scenes: | FXE_OGT1_IPM/TSENS/TEMP4, FXE_OGT1_IPM/TSENS/TEMP4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### MOV

##### MOTOR

###### X_1

###### X_2

###### Y_1

###### Y_2

###### Y_3

#### PSLIT

##### ENC

###### BLADE1_IN_OUT

Instance id: | FXE_OGT1_PSLIT/ENC/BLADE1_IN_OUT
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_PSLIT, FXE_LOOP1, FXE_OGT1_PSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE2_IN_OUT

Instance id: | FXE_OGT1_PSLIT/ENC/BLADE2_IN_OUT
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_PSLIT, FXE_OGT1_PSLIT, FXE_LOOP1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE3_IN_OUT

Instance id: | FXE_OGT1_PSLIT/ENC/BLADE3_IN_OUT
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_PSLIT, FXE_LOOP1, FXE_OGT1_PSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE4_IN_OUT

Instance id: | FXE_OGT1_PSLIT/ENC/BLADE4_IN_OUT
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_PSLIT, FXE_LOOP1, FXE_OGT1_PSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MDL

###### MAIN

Instance id: | FXE_OGT1_PSLIT/MDL/MAIN
Class id: | SlitSystem
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-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: | FXE_OGT1_PSLIT/MDL/MAIN|SimpleControl, FXE_OGT1_PSLIT/MDL/MAIN|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

###### BLADE1_IN_OUT

Instance id: | FXE_OGT1_PSLIT/MOTOR/BLADE1_IN_OUT
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_LOOP1, FXE_OGT1_PSLIT
Scenes: | FXE_OGT1_PSLIT/MOTOR/BLADE1_IN_OUT|motorScene, FXE_OGT1_PSLIT/MOTOR/BLADE1_IN_OUT, FXE_OGT1_PSLIT/MOTOR/BLADE1_IN_OUT|motorScene, OVERVIEW_OGT1_PSLIT, FXE_OGT1_PSLIT-MOTOR-BLADE1_IN_OUT, FXE_OGT1_PSLIT-MOTOR-BLADE1_IN_OUT, FXE_OGT1_PSLIT/MDL/MAIN|Control, FXE_OGT1_PSLIT-MOTOR-BLADE1_IN_OUT, FXE_OGT1_PSLIT/MOTOR/BLADE1_IN_OUT, IntensityScan_toDelete0604, IntensityScan2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### BLADE2_IN_OUT

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.

###### BLADE3_IN_OUT

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.

###### BLADE4_IN_OUT

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.

##### TSENS

###### BLADE1_TEMP1

Instance id: | FXE_OGT1_PSLIT/TSENS/BLADE1_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_LOOP1, FXE_OGT1_PSLIT
Scenes: | FXE_OGT1_PSLIT/TSENS/BLADE1_TEMP1, FXE_OGT1_PSLIT/TSENS/BLADE1_TEMP1, OVERVIEW_OGT1_PSLIT, OVERVIEW_OGT1_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE1_TEMP2

Instance id: | FXE_OGT1_PSLIT/TSENS/BLADE1_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_OGT1_PSLIT, FXE_LOOP1
Scenes: | FXE_OGT1_PSLIT/TSENS/BLADE1_TEMP2, FXE_OGT1_PSLIT/TSENS/BLADE1_TEMP2, OVERVIEW_OGT1_PSLIT, OVERVIEW_OGT1_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE2_TEMP1

Instance id: | FXE_OGT1_PSLIT/TSENS/BLADE2_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_OGT1_PSLIT, FXE_LOOP1
Scenes: | FXE_OGT1_PSLIT/TSENS/BLADE2_TEMP1, FXE_OGT1_PSLIT/TSENS/BLADE2_TEMP1, OVERVIEW_OGT1_PSLIT, OVERVIEW_OGT1_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE2_TEMP2

Instance id: | FXE_OGT1_PSLIT/TSENS/BLADE2_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_OGT1_PSLIT, FXE_LOOP1
Scenes: | FXE_OGT1_PSLIT/TSENS/BLADE2_TEMP2, FXE_OGT1_PSLIT/TSENS/BLADE2_TEMP2, OVERVIEW_OGT1_PSLIT, OVERVIEW_OGT1_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE3_TEMP1

Instance id: | FXE_OGT1_PSLIT/TSENS/BLADE3_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_LOOP1, FXE_OGT1_PSLIT
Scenes: | FXE_OGT1_PSLIT/TSENS/BLADE3_TEMP1, OVERVIEW_OGT1_PSLIT, OVERVIEW_OGT1_PSLIT, FXE_OGT1_PSLIT/TSENS/BLADE3_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE3_TEMP2

Instance id: | FXE_OGT1_PSLIT/TSENS/BLADE3_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_OGT1_PSLIT, FXE_LOOP1
Scenes: | FXE_OGT1_PSLIT/TSENS/BLADE3_TEMP2, FXE_OGT1_PSLIT/TSENS/BLADE3_TEMP2, OVERVIEW_OGT1_PSLIT, OVERVIEW_OGT1_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE4_TEMP1

Instance id: | FXE_OGT1_PSLIT/TSENS/BLADE4_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_OGT1_PSLIT, FXE_LOOP1
Scenes: | FXE_OGT1_PSLIT/TSENS/BLADE4_TEMP1, FXE_OGT1_PSLIT/TSENS/BLADE4_TEMP1, OVERVIEW_OGT1_PSLIT, OVERVIEW_OGT1_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE4_TEMP2

Instance id: | FXE_OGT1_PSLIT/TSENS/BLADE4_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_PSLIT, FXE_OGT1_PSLIT, FXE_LOOP1
Scenes: | FXE_OGT1_PSLIT/TSENS/BLADE4_TEMP2, OVERVIEW_OGT1_PSLIT, OVERVIEW_OGT1_PSLIT, FXE_OGT1_PSLIT/TSENS/BLADE4_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### SA

##### CAL

###### DETECTOR

Instance id: | FXE_OGT1_SA/CAL/DETECTOR
Class id: | SlsCalibrator
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/slsCalibrator
Last modified: | 2021-08-06T08:25:04.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Parenti, Hauf, Danilevski
Latest tag: | 1.5.1-2.11.0
Deployment tag: | 1.5.1-2.11.0
Scenes: | FXE_OGT1-SpA1_overview, Gotthard, test_Scene, FXE_OGT1_SA-DET-DETECTOR
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!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- bkg:
    The background on ADC counts.
- cal:
    The calibration constants [keV/counts].
- averagedDisplay:
    Average all the frames in the train and then display.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.
- useBackgroundFrame:
    Use Frame for Background subtraction
- frameNumber:
    The index of the frame to be used for background subtraction
- errorCount:
    Number of errors.
- reset:
    Reset error count.

Release History
1.5.1-2.11.0

Created: | 2021-08-04T16:24:38.000+02:00
Author: | Alessandro Silenzi
Notes: | revert change in schema types.

1.5.0-2.11.0

Created: | 2021-07-26T17:39:35.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: output channel data matches the type in the schema. Schema changed properties VECTOR_FLOAT -> VECTOR_DOUBLE

1.4.1-2.10.0

Created: | 2020-11-24T12:14:02.000+01:00
Author: | Andrea Parenti
Notes: | Summary: added version info

1.4.0-2.5.1

Created: | 2019-08-08T15:22:44.000+02:00
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T14:31:43.000+02:00
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T12:01:40.000+02:00
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T13:58:56.000+01:00
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T10:34:30.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T14:50:05.000+01:00
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T11:28:08.000+01:00
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T18:29:31.000+02:00
Author: | Andrea Parenti
Notes: |

###### GOTTHARD

Instance id: | FXE_OGT1_SA/CAL/GOTTHARD
Host: | exflcon07n0
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsCalibrator
Last modified: | 2019-08-12T13:16:18.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Danilevski, Baumann, Parenti
Latest tag: | 1.4.0-2.5.1
Deployment tag: | 1.4.0-2.5.1
Scenes: | Gotthard_Calibration
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- _deviceId_:

    Do not set this property, it will be set by the device-server

- 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.

- _serverId_:

    Do not set this property, it will be set by the device-server

- 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 defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

    Do not set this property, it will be set by the device-server.

- pid:

    The unix process ID of the device

- 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:

    Calibrate actual position to calibrated position.

- availableScenes:

    Scenes from the Slit System

- _connection_:

    The connection to the communication layer of the distributed system

- useTimeserver:

    Unused - whether device connects to time server is configured via ‘timeServerId’

- progress:

    The progress of the current action

- 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:

    Reset error count.

- enableInterlockedSlots:

    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

- disableInterlockedSlots:

    Send device into INTERLOCKED state, thus enabling all interlocked slots.

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

- readHardware:

    Requests value updates from the PLC for the properties listed under ‘Properties to read’

- force:

    ???

- trigger:

    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.

- 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

- moveModulo:

- 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

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    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.

- topChannel:

    Please specify the ADC channel which correspond to Top

- bottomChannel:

    Please specify the ADC channel which correspond to Bottom

- leftChannel:

    Please specify the channel which correspond to Left

- rightChannel:

    Please specify the channel which correspond to Right

- calibrationFactorX:

    Calibration Factor to align beam position in x direction

- calibrationFactorY:

    Calibration Factor to align beam position in y direction

- upperBound:

    upper range of window to select desired pulses

- lowerBound:

    Lower range of window to select desired pulses

- temporalAverage:

    Average is evaluated over N last Trains

- numberOfPulses:

    Number of pulses per train

- pulseThreshold:

    Threshold to validate the pulse

- trainThreshold:

    Threshold to validate the train

- pulseValidity:

    True, if a value of all channels at a given pulses are greater than pulse threshold otherwise false

- trainValidity:

    True, if pulseValidity of all channels are greater than train threshold otherwise false

- quadrant:

    Quadrant

- scatterPosition:

    Scatter Position Node

- reconnectInterval:

    Reconnect Interval to DOOCS in case of ERROR

- location:

    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION

- updateInterval:

    Update interval.

- lockStatus:

    O: Locked - 1: NOT locked - 3: Unknown

- lock:

    Lock the laser by setting the coarseTune to ID: 3

- unlock:

    Unlock the laser by setting the coarseTune to ID: 7

- 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

- stepLength:

    Step length used in Step Up/Step Down.

- zeroAngle:

    The position of the motor where the zero angle is defined

- offsetIntensity:

    Defines the lowest soft limit

- 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

- timeoutConnectToBCom:

    Timeout for succesfully connect to PLC

- timeoutReadDevConfig:

    Timeout for getting the same number of failures when reading the configuration of devices

- setDefaultDevConfig:

    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device

- outputFileRoot:

    Template string for output XML file

- inputFileTemplate:

    File with variables to save in FW

- configDir:

    Folder to store configuration files

- plcInFwTemplate:

    List of PLCs which have a specific configuration to save, as found in the FW Template

- instantiateDevices:

    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.

- instantiateQuick:

    Instantiate all devices on selected PLC quickly

- instantiateGroupDevices:

    Instantiate all selected group devices in selected PLC

- instantiateComponentDevices:

    Instantiate all selected component devices in selectedPLC

- resetDevices:

    Reset all devices in Error state

- getOfflineDevices:

    Check which devices are still offline

- shutdownDevices:

    Shutdown all devices

- shutdownGroupDevices:

    Shutdown all group devices

- shutdownComponentDevices:

    Shutdown all component devices

- getPLCsInFwTemplate:

    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.

- getPLCsInSystem:

    Get list of PLCs active in current topic

- handleMultiConfigToXML:

    The retrieved config of devices in PLCs is written on an XML file

- handleSingleConfigToXML:

    The retrieved config of devices in selected beckhoffId is written in XML file

- serverUri:

    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.

- serverTimeout:

    Timeout for server responses.

- autoResetTime:

    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.

- connectionSettlingTime:

    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- plcUptime:

    Total time (in seconds), that the PLC server is up and running

- createGenericDevices:

    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.

- messageRateOut:

    The average rate of messages sent by BeckhoffCom

- messageRateIn:

    The average rate of messages received by BeckhoffCom

- byteRateOut:

    The average rate of bytes sent by BeckhoffCom

- byteRateIn:

    The average rate of bytes received by BeckhoffCom

- availablePlcDevices:

    Lists all available PLC devices

- updatesRate:

    The average rate of updates to the Beckhoff Devices

- devicesBlacklist:

    List of the devices that will not be instantiated automatically.

- instantiationInterval:

    The interval between consecutive instantiations

- ACpuFrequency:

    Frequency of the CPU.

- ACurrentCpuUsage:

    Current CPU usage.

- ACurrentCpuTemperature:

    Current temperature of the CPU.

- AProgramMemoryAllocated:

    Allocated program memory.

- AProgramMemoryAvailable:

    Available program memory.

- AStorageMemoryAllocated:

    Allocated storage-memory. Available on Windows CE.

- AStorageMemoryAvailable:

    Available storage-memory. Available on Windows CE.

- AMemoryDivision:

    MemoryDivision. Available on Windows CE.

- AProgramMemoryAllocated2:

    Allocated program memory.

- AProgramMemoryAvailable2:

    Available program memory.

- AMacAddess:

    MAC-Address of the PLC (17 char string).

- AIpv4Address:

    Current IPv4 Address of the PLC in dotted notation (15 char string).

- AIpv4SubnetMask:

    IPv4 subnet mask of the PLC in dotted notation (15 char string).

- ADhcpServerIpv4Address:

    IP-Address of the DHCP-Server in dotted notation (15 char string).

- ADhcpServerEnabled:

    True if the DHCP-Server is enabled.

- AMainboardType:

    Type of the main-board.

- ASerialNumber:

    Serial number.

- AProductionDate:

    Production date of the main-board.

- ABootCount:

    Boot count.

- AOperatingTimeInMinutes:

    Operating time of the main-board.

- AMinBoardTemperature:

    Minimum temperature of the main-board.

- AMaxBoardTemperature:

    Maximum temperature of the main-board.

- MinInputVoltage:

    Minimum input voltage of the main-board.

- MaxInputVoltage:

    Maximum input voltage of the main-board.

- MainboardTemperature:

    Current temperature of the main-board.

- APlcProjectVersion:

    PLC Project Version

- AProjectGeneratorVersion:

    Project Generator Version

- ATCPBufferSize:

    TCP/IP buffer size.

- ATrainID:

    Train ID

- ABeamModes:

    Beam Modes

- ATCPOutputDataRate:

    TCP Output Data Rate

- ATCPOutputBufLvlMax:

    TCP Output Buf Lvl Max

- ATCPInputDataRate:

    TCP Input Data Rate

- ATCPInputBufLvlMax:

    TCP Input Buf Lvl Max

- APLCCycleTime:

    PLC Cycle Time

- ignore:

    Ignore

- configure:

    Upload configuration parameters to the FEM

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- lastStatusMessage:

    Status message of last command

- loggerConfig:

    Runtime logger configuration

- policy:

    Errors handling policy

- ApplicationMonitor:

    Application health monitor

- BookKeeper:

    Book keeper

- BufferManager:

    Buffer manager

- DataAccessor0:

    Data accessor 0

- DataAccessor1:

    Data accessor 1

- DataDispatcher:

    Data dispatcher

- DataIntegrator:

    Data integrator

- DataMonitor:

    Data content monitor

- FastDataCollector:

    Fast data collector

- Formatter:

    Formatter

- InternalTrigger:

    Internal trigger

- MessageLogger:

    Message logger

- PreProcessor:

    Pre processor

- Scheduler:

    Scheduler

- SlowDataCollector:

    Slow data collector

- StatisticsBuilder:

    Statistics builder

- Summarizer:

    Data summarizer

- TrainDataReceiver:

    Train data receiver

- TrainReconstructor:

    Train data reconstructor

- Vectorizer:

    Data vectorizer

- Writer:

    Writer

- enableDaqNode:

    Enable DAQ node

- storageManager:

    Storage manager device

- groupId:

    Aggregators group Id

- groupInfix:

    Aggregators group infix

- channelId:

    channel Id

- channelsCount:

    Number of channels

- mountPoint:

    Mount point

- dataPath:

    Proposal data path

- chunkSize:

    Number of trains to buffer in memory

- chunksCount:

    Chunk count per file

- maxExpectedPulses:

    Maximum number of pulses expected per train

- dataType:

    Data type

- runController:

    The deviceId of the RunController to use, starts and stops daq.

- experimentDetails:

    Experiment details

- sampleDetails:

    Sample details

- runDetails:

    Run details

- enableXTDF:

    Enable receiving train data via UDP

- OriginalDataFormat:

    Name of file that contains the original data format description, include train data format, dataset and run info.

- Detector:

    Name of file that contains the detector configuration.

- timeServerId:

    The instance id uniquely identifies a TimeServer instance in the distributed system

- Logger:

    Logging settings

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- 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

- group:

    Structure describing data sources logically belonging together.

- owner:

    The person to contact regarding usage of this group

- 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

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Start DAQ & set the fast_data

- setup:

    Configure the DAQ before acquisition and check device states.

- createGrid:

    Create a parallelogram with the following input

    > steps_x, steps_y, v_bl=None, v_br=None, v_tl=None, v_tr=None, exclude=”topRight”

- 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

- 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 triggers stays this long in ACQUIRING state

- 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’.

- availableMacros:

    Provides scan macros from the scan device

- output:

    Output Channel for the scan data

- abort:

    Call this slot to stop everything

- pause:

    Call this slot to pause or resume running scan

- proxy:

    The Clock and Control device

- uploadOk:

    Was the upload to Veto Memory Successful

- displayedSequence:

    Sequence generated from user input

- displayedBinOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered

- displayedOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered, human readable

- vetoMode:

    The mode in which to generate the pattern.

- inputString:

    The input can be valid python code, that generates either an integer, or an iterable of integers. When doing equations, remember to cast your floats to ints.

- saveVetoPatternFile:

    Save VETO pattern to disk file, as configured in the CCMon device

- uploadPatternFile:

    Upload VETO pattern from file into VETO memory, as configured in the CCMon device, and check that the upload was correct

- deviceNames:

    The LpdFem devices to be sub-control

- connectFem:

    Open connection to FEM

- disconnectFem:

    Close connection to FEM

- prepare:

    Prepare new configuration parameters for the FEM

- startDAQ:

    Start data acquisition

- stopDAQ:

    Stop acquisition immediately

- sync_params:

    Sets all composite parameters on fems.

- manual_recover:

    Try recovery from UNKNOWN after state desynchronization has been manually solved for the respective children.

- asicPowerEnable0:

    ASIC 0 LV Power Enable

- asicPowerEnable1:

    ASIC 1 LV Power Enable

- asicRxGainAlgorithmType:

    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)

- asicRxGainThresholdx10:

    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- asicRxGainThresholdx100:

    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- cccEmulationMode:

    Enable to emulate Clock & Control commands (for testing in absence of C&C)

- cccProvideNumberImages:

    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages

- cccResetDelay:

    Adjust timing of reset (in steps of clock cycles)

- cccStopDelay:

    Adjust timing of the stop (in steps of clock cycles)

- cccSystemMode:

    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes

- cccVetoPatternFile:

    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)

- cccVetoStartDelay:

    Adjust timing of veto arrival (in steps of clock cycles)

- femAsicClockSource:

    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond

- femAsicCmdSequence:

    ASIC Command Words defined in XML syntax

- femAsicCommandLength:

    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz

- femAsicDataType:

    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom

- femAsicGain:

    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)

- femAsicPixelFeedbackOverride:

    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides

- femAsicPixelSelfTestOverride:

    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides

- femAsicSetupParams:

    ASIC Setup Parameters defined in XML syntax

- femInvertAdcData:

    Enable Invert ADC ASIC data True=Invert Data

- femPpcEmulatePipeline:

    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors

- femPpcImageReordering:

    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled

- femPpcMode:

    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout

- femStartTrainDelay:

    Delay between trigger arrival and start of train (in FEM clock cycles)

- femStartTrainInhibit:

    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout

- femStartTrainPolarity:

    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal

- femStartTrainSource:

    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond

- femVetoPolarity:

    Set polarity of the external veto signal 0=No inversion, 1=Invert signal

- integrationCycles:

    Sets the number of integration cycles per images

- numPulsesInTrainOverride:

    Length of XRay Pulse Train (number pulses)

- numberImages:

    Sets the number of images per trigger

- numberTrains:

    Number of trains [if LL Data Generator or PPC Data Direct selected]

- sensorBias0:

    Sensor 0 HV Bias Voltage [V]

- sensorBias1:

    Sensor 1 HV Bias Voltage [V]

- sensorBiasEnable0:

    Sensor 0 HV Bias Enable

- sensorBiasEnable1:

    Sensor 1 HV Bias Enable

- tenGigInterframeGap:

    10GigE Inter-frame gap timer [clock cycles]

- tenGigUdpPacketLen:

    10GigE UDP packet payload length

- timeoutTrain:

    Timeout in seconds on waiting for next Train during run

- trainGenInterval:

    Interval (in 100 mhz clock periods) between internally generated Train start commands

- proxyCACML:

    The Clock and Control device

- fem:

    Device controlling Fem, can be composite

- ccMon:

    Device controlling clock & control.

- data_taking:

    Detector Device That Implements TakeData Function.

- x2Timer:

    The utca device

- cancel:

    Cancels last button pressed.

- femBootUpTime:

    Time needed for FEM to be responsive after powering up [s].

- asicBootUpTime:

    Time needed for asics to follow last commands [s].

- powerTimeout:

    Time needed for power to arrive at all FEMS [s].

- configTimeout:

    Time needed for femComposit to upload config

- scenarioConfig:

    Configuration of common operation scenarios

- emergencyShutdown:

    Power off quadrants immediately.

- uploadConfig:

    Sends selected configuration to detector.

- getReady:

    Bring detector in a state ready for data taking

- startDisablePower:

    Disable LPDpower & …

- disable:

    Disable FEM to be ignored

- enable:

    Enable FEM to be part of the system

- disabled:

    Disable FEM, will no longer be controlled by the composite

- sys_status:

    Status summary

- error_msg:

    Error message.

- sync_start_time:

    Unix timestamp to trigger start at

- femHost:

    FEM hostname or IP address

- femPort:

    FEM port number

- femTimeout:

    FEM connection timeout

- femAsicModuleType:

    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone

- femLegacyPowerCard:

    Enable legacy power card support

- tenGig0SourceMac:

    10GigE 0 UDP Source MAC Address

- tenGig0SourceIp:

    10GigE 0 UDP Source IP Address

- tenGig0SourcePort:

    10GigE 0 UDP Source Port

- tenGig0DestMac:

    10GigE 0 UDP Destination MAC Address

- tenGig0DestIp:

    10GigE 0 UDP Destination IP Address

- tenGig0DestPort:

    10GigE 0 UDP Destination Port

- femEnableTenGig:

    Enables transmission of image data via 10GigE UDP interface

- femDataSource:

    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)

- femAsicEnableMask:

    ASIC RX channel enable mask (4*32 bits)

- femReadoutOperatingMode:

    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD

- femAsicLocalClock:

    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)

- femAsicSetupLoadMode:

    ASIC control load mode 0=parallel, 1=daisy chain (being tested)

- femAsicRxCmdWordStart:

    Enable ASIC readout started by Command Word in femAsicCmdSequence file

- femAsicSetupClockPhase:

    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset

- tenGigFarmMode:

    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists

- femAsicVersion:

    ASIC Version 1=version 1, 2=version 2

- femAsicGainOverride:

    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)

- femDebugLevel:

    Set the debug level

- tenGig0DataGenerator:

    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0DataFormat:

    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0FrameLength:

    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0NumberOfFrames:

    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]

- femModuleId:

    ID for FEM to differentiate from which FEM data is coming from 0 - 15

- femAsicTestDataPatternType:

    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image

- femTrainIdInitLsw:

    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker

- femTrainIdInitMsw:

    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker

- powerCardFault0:

    Power Card 0 Fault Flag

- powerCardFault1:

    Power Card 1 Fault Flag

- powerCardFemStatus0:

    Power Card 0 FEM Status Flag

- powerCardFemStatus1:

    Power Card 1 FEM Status Flag

- powerCardExtStatus0:

    Power Card 0 External Status Flag

- powerCardExtStatus1:

    Power Card 1 External Status Flag

- powerCardOverCurrent0:

    Power Card 0 Overcurrent Flag

- powerCardOverCurrent1:

    Power Card 1 Overcurrent Flag

- powerCardOverTemp0:

    Power Card Over 0 Temperature Flag

- powerCardOverTemp1:

    Power Card Over 1 Temperature Flag

- powerCardUnderTemp0:

    Power Card Under 0 Temperature Flag

- powerCardUnderTemp1:

    Power Card Under 1 Temperature Flag

- powerCardTemp0:

    Power Card 0 Temperature [C]

- powerCardTemp1:

    Power Card 1 Temperature [C]

- sensor0Temp:

    Sensor 0 Temperature [C]

- sensor1Temp:

    Sensor 1 Temperature [C]

- sensor2Temp:

    Sensor 2 Temperature [C]

- sensor3Temp:

    Sensor 3 Temperature [C]

- sensor4Temp:

    Sensor 4 Temperature [C]

- sensor5Temp:

    Sensor 5 Temperature [C]

- sensor6Temp:

    Sensor 6 Temperature [C]

- sensor7Temp:

    Sensor 7 Temperature [C]

- sensor8Temp:

    Sensor 8 Temperature [C]

- sensor9Temp:

    Sensor 9 Temperature [C]

- sensor10Temp:

    Sensor 10 Temperature [C]

- sensor11Temp:

    Sensor 11 Temperature [C]

- sensor12Temp:

    Sensor 12 Temperature [C]

- sensor13Temp:

    Sensor 13 Temperature [C]

- sensor14Temp:

    Sensor 14 Temperature [C]

- sensor15Temp:

    Sensor 15 Temperature [C]

- femVoltage0:

    FEM 5V Supply 0 Voltage [V]

- femVoltage1:

    FEM 5V Supply 1 Voltage [V]

- femCurrent0:

    FEM 5V Supply 0 Current [A]

- femCurrent1:

    FEM 5V Supply 1 Current [A]

- digitalVoltage0:

    ASIC 1.2V Digital Supply 0 Voltage [V]

- digitalVoltage1:

    ASIC 1.2V Digital Supply 1 Voltage [V]

- digitalCurrent0:

    ASIC 1.2V Digital Supply 0 Current [mA]

- digitalCurrent1:

    ASIC 1.2V Digital Supply 1 Current [mA]

- sensor0Voltage:

    Sensor 0 3.3V Supply Voltage [V]

- sensor1Voltage:

    Sensor 1 3.3V Supply Voltage [V]

- sensor2Voltage:

    Sensor 2 3.3V Supply Voltage [V]

- sensor3Voltage:

    Sensor 3 3.3V Supply Voltage [V]

- sensor4Voltage:

    Sensor 4 3.3V Supply Voltage [V]

- sensor5Voltage:

    Sensor 5 3.3V Supply Voltage [V]

- sensor6Voltage:

    Sensor 6 3.3V Supply Voltage [V]

- sensor7Voltage:

    Sensor 7 3.3V Supply Voltage [V]

- sensor8Voltage:

    Sensor 8 3.3V Supply Voltage [V]

- sensor9Voltage:

    Sensor 9 3.3V Supply Voltage [V]

- sensor10Voltage:

    Sensor 10 3.3V Supply Voltage [V]

- sensor11Voltage:

    Sensor 11 3.3V Supply Voltage [V]

- sensor12Voltage:

    Sensor 12 3.3V Supply Voltage [V]

- sensor13Voltage:

    Sensor 13 3.3V Supply Voltage [V]

- sensor14Voltage:

    Sensor 14 3.3V Supply Voltage [V]

- sensor15Voltage:

    Sensor 15 3.3V Supply Voltage [V]

- sensor0Current:

    Sensor 0 3.3V Supply Current [A]

- sensor1Current:

    Sensor 1 3.3V Supply Current [A]

- sensor2Current:

    Sensor 2 3.3V Supply Current [A]

- sensor3Current:

    Sensor 3 3.3V Supply Current [A]

- sensor4Current:

    Sensor 4 3.3V Supply Current [A]

- sensor5Current:

    Sensor 5 3.3V Supply Current [A]

- sensor6Current:

    Sensor 6 3.3V Supply Current [A]

- sensor7Current:

    Sensor 7 3.3V Supply Current [A]

- sensor8Current:

    Sensor 8 3.3V Supply Current [A]

- sensor9Current:

    Sensor 9 3.3V Supply Current [A]

- sensor10Current:

    Sensor 10 3.3V Supply Current [A]

- sensor11Current:

    Sensor 11 3.3V Supply Current [A]

- sensor12Current:

    Sensor 12 3.3V Supply Current [A]

- sensor13Current:

    Sensor 13 3.3V Supply Current [A]

- sensor14Current:

    Sensor 14 3.3V Supply Current [A]

- sensor15Current:

    Sensor 15 3.3V Supply Current [A]

- sensorBiasVoltage0:

    Sensor bias 0 voltage readback [V]

- sensorBiasVoltage1:

    Sensor bias 1 voltage readback [V]

- sensorBiasCurrent0:

    Sensor bias 0 current readback [uA]

- sensorBiasCurrent1:

    Sensor bias 1 current readback [uA]

- femV5FirmwareVersion:

    FEM V5 Firmware Version

- femBotSp3FirmwareVersion:

    FEM Bottom SP3 FPGA Firmware Version

- femTopSp3FirmwareVersion:

    FEM Top SP3 FPGA Firmware Version

- femCfgSp3FirmwareVersion:

    FEM Config SP3 FPGA Firmware Version

- femLpdClientVersion:

    LpdFemClient Software Version - Read Only

- femReadoutActive:

    FEM readout is active

- femBoardTemperature:

    FEM Board Sensor Temperature [C] Reading

- femCoreTemperature:

    FEM Core Sensor Temperature [C] Reading

- auto_mode:

    Configure default configuration when taking darks

- take_dark_frames:

    Take set of dark frames.

- startScan:

    Value with which to start scan.

- stopScan:

    Value around which to stop scan. Depends on start value and step size if it is reached exactly.

- nSteps:

    Number of steps in the intervall between start and stop.

- optWithCCMon:

    To choose delay scan with or without C&C

- delayScanSleepTime:

    Time needed for X2Timer to delay scan with C&C [s].

- delayScan:

    Start delay scan.

- runControl:

    Device controlling run management.

- self_check:

    Check if all conditions are ok for data taking.

- control:

    Control of system variables

- powerEnable:

    Allow all quadrants to receive power.

- powerDisable:

    Forbid all quadrants to receive power.

- armInterlock:

    Arm interlock to be able to power quadrants.

- disarmInterlock:

    Disarm interlock, no power allowed to quadrants.

- quad1:

    Quad1 node

- quad4:

    Quad4 node

- quad2:

    Quad2 node

- quad3:

    Quad3 node

- temperature:

    Camera temperature. Not available for all models.

- humidity:

    Humidity sensors

- leakimpedance:

    Leak sensors

- pump:

    Pump variables

- fan:

    Fan variables

- 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

- 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

- value:

    Analog input of ADC.

- semiRawValue:

    Semi raw value of analog input, i.e. the voltage.

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- relativeEpsilon:

    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- 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

- extractedLabels:

    Out positions: labels, where the imager is extracted from the beam.

- tolerance:

    Position tolerance for increment detection

- moveOUT:

    Moves the motor to the position marked with this label

- moveC:

    Moves the motor to the position marked with this label

- moveC/:

    Moves the motor to the position marked with this label

- moveYAG:

    Moves the motor to the position marked with this label

- useAsBackgroundImage:

    Use the current image as background image.

- filterImagesByThreshold:

    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

- imageThreshold:

    The threshold for processing an image.

- absolutePositions:

    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

- subtractBkgImage:

    Subtract the loaded background image.

- subtractImagePedestal:

    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

- doMinMaxMean:

    Get the following information from the pixels: min, max, mean value.

- doBinCount:

    Calculate the frequency distribution of pixel values.

- doXYSum:

    Integrate the image along the x- and y-axes.

- doCOfM:

    Calculate centre-of-mass and widths.

- do1DFit:

    Perform a 1D gaussian fit of the x- and y-distributions.

- do2DFit:

    Perform a 2D gaussian fits.Be careful: It can be slow!

- doIntegration:

    Perform integration over region.

- clipValues:

    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

- comRange:

    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

- userDefinedRange:

    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- absThreshold:

    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

- threshold:

    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

- pixelSize:

    The pixel size. It will be used when evaluating the beam size.

- fitRange:

    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

- rangeForAuto:

    The automatic range for ‘auto’ mode (in standard deviations).

- enablePolynomial:

    Add a 1st order polynomial term (ramp) to gaussian fits.

- gauss1dStartValues:

    Selects how 1D gauss fit starting values are evaluated

- doGaussRotation:

    Allow the 2D gaussian to be rotated.

- integrationRegion:

    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- thresholdRange:

    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

- imageWidth:

    The width of the incoming image.

- imageOffsetX:

    If the incoming image has a ROI, this represents the X position of the top-left corner.

- imageBinningX:

    The image binning in the X direction.

- imageHeight:

    The height of the incoming image. Set to 1 for 1D images (spectra).

- imageOffsetY:

    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

- imageBinningY:

    The image binning in the Y direction. Set to 1 for 1D images (spectra).

- minPxValue:

    The minimum image pixel value.

- maxPxValue:

    The maximum image pixel value.

- meanPxValue:

    The mean image pixel value.

- minMaxMeanTime:

    Time spent for evaluating min, max, mean pixel value.

- binCountTime:

    Time spent for calculating the frequency distribution of pixel values.

- subtractBkgImageTime:

    Time spent in subtracting the background image.

- subtractPedestalTime:

    Time spent in subtracting the image pedestal.

- xYSumTime:

    Time spent in integrating the image in X and Y.

- cOfMTime:

    Time spent in evaluating the centre-of-mass.

- xFitTime:

    Time spent in 1D Gaussian fit of the X distribution.

- yFitTime:

    Time spent in 1D Gaussian fit of the Y distribution.

- fitTime:

    Time spent in 2D Gaussian fit of the image.

- integrationTime:

    Time spent in integrating over a region.

- x0:

    X position of the centre-of-mass.

- sx:

    Standard deviation in X of the centre-of-mass.

- y0:

    Y position of the centre-of-mass.

- sy:

    Standard deviation in Y of the centre-of-mass.

- xFitSuccess:

    1D Gaussian fit success (1-4 if fit converged).

- ax1d:

    Amplitude Ax from the 1D fit.

- x01d:

    x0 from 1D Fit.

- ex01d:

    Uncertainty on x0 estimation.

- sx1d:

    Standard deviation on x0 from 1D fit.

- esx1d:

    Uncertainty on standard deviation estimation.

- beamWidth1d:

    Beam width from 1D Fit. Defined as 4x sigma_x.

- yFitSuccess:

    1D Gaussian Fit Success (1-4 if fit converged).

- ay1d:

    Amplitude Ay from 1D fit.

- y01d:

    y0 from 1D Fit.

- ey01d:

    Uncertainty on y0 estimation.

- sy1d:

    Standard deviation on y0 from 1D fit.

- esy1d:

    Uncertainty on standard deviation estimation.

- beamHeight1d:

    Beam heigth from 1D Fit. Defined as 4x sigma_y.

- fitSuccess:

    2D Gaussian fit success (1-4 if fit converged).

- a2d:

    Amplitude from 2D fit.

- x02d:

    x0 from 2D Fit.

- ex02d:

    Uncertainty on x0 estimation.

- sx2d:

    Standard deviation on x0 from 2D fit.

- esx2d:

    Uncertainty on standard deviation estimation.

- beamWidth2d:

    Beam width from 2D Fit. Defined as 4x sigma_x.

- y02d:

    y0 from 2D Fit.

- ey02d:

    Uncertainty on y0 estimation.

- sy2d:

    Standard deviation on y0 from 2D fit.

- esy2d:

    Uncertainty on standard deviation estimation.

- beamHeight2d:

    Beam height from 2D Fit. Defined as 4x sigma_y.

- theta2d:

    Rotation angle from 2D fit.

- etheta2d:

    Uncertainty on rotation angle estimation.

- regionIntegral:

    Integral of pixel value over region specified by integrationRegion.

- regionMean:

    Mean pixel value over region specified by integrationRegion.

- moveC1:

    Moves the motor to the position marked with this label

- moveC2:

    Moves the motor to the position marked with this label

- bkg:

    The background on ADC counts.

- cal:

    The calibration constants [keV/counts].

- averagedDisplay:

    Average all the frames in the train and then display.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.

- useBackgroundFrame:

    Use Frame for Background subtraction

- frameNumber:

    The index of the frame to be used for background subtraction

- errorCount:

    Number of errors.

Release History
1.4.0-2.5.1

Created: | 2019-08-08T13:22:44.000Z
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T12:31:43.000Z
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T10:01:40.000Z
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T12:58:56.000Z
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T08:34:30.000Z
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T13:50:05.000Z
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T10:28:08.000Z
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T16:29:31.000Z
Author: | Andrea Parenti
Notes: |

##### CAM

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DAQ

###### DETECTOR

Instance id: | FXE_OGT1_SA/DAQ/DETECTOR
Class id: | GotthardReceiver
Host: | fxe-rr-sys-con-1
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
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
Projects: | FXE_OGT1_SA, FXE_LOOP1, FXE_OGT1_BIU
Scenes: | Gotthard, test_Scene, FXE_OGT1_SA/DAQ/DETECTOR, FXE_OGT1_SA-DET-DETECTOR
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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

##### DET

###### CONTROL

Instance id: | FXE_OGT1_SA/DET/CONTROL
Class id: | GotthardControl
Host: | exflcon07n0
Class documentation:
| GotthardControl
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-08-05T15:05:54.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.0-2.9.1
Deployment tag: | 1.8.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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

Release History
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.

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

###### DETECTOR

Instance id: | FXE_OGT1_SA/DET/DETECTOR
Class id: | GotthardControl
Host: | fxe-rr-sys-con-1
Class documentation:
| GotthardControl
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
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
Projects: | FXE_OGT1_SA, FXE_LOOP1, FXE_OGT1_BIU
Scenes: | FXE_OGT1-SpA1_overview, Gotthard, test_Scene, FXE_OGT1_SA/DET/DETECTOR, test_fastAdc, FXE_OGT1_SA-DET-DETECTOR
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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Starts acquisition
- stop:
    Stops acquisition
- reset:
    Resets the device in case of an error
- detectorHostName:
    Detector Host Name
- detectorIp:
    Detector IP. Must be on the same subnet as the receiver.
- detectorHostPort:
    Detector Host Port. Will use 1952 if left empty.
- detectorHostStopPort:
    Detector Host Stop Port. Will use 1953 if left empty.
- rxHostname:
    Receiver Hostname
- rxTcpPort:
    Receiver TCP Port
- rxUdpIp:
    Receiver UDP IP
- rxUdpPort:
    Receiver UDP Port
- settings:
    Settings
- online:
    Sets the detector in online (1) or offline (0) mode.
- angDir:
    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).
- moveFlag:
    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)
- lock:
    lock
- extSig0:
    Ext Sig 0
- vHighVoltageMax:
    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.
- vHighVoltage:
    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200
- master:
    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.
- sync:
    Sets the synchronization mode of the various controller within a detector structure
- badChannels:
    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.
- angConv:
    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.
- globalOff:
    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.
- binSize:
    Sets the size of the angular bins for angular conversion.
- threaded:
    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
- detectorDeveloper:
    Detector Developer. (useful to define subset of working functions)
- flatFieldCorrectionFile:
    Flat field corrections file name. Use ‘none’ to disable corrections.
- positions:
    Positions for the acquisition. Usage: n pos1 pos2 … posn
- maximumDetectorSize:
    Maximum detector size
- bitDepth:
    Bit Depth
- exposureTime:
    exposure time value
- exposurePeriod:
    exposure period
- delayAfterTrigger:
    delay after trigger
- numberOfGates:
    Number Of Gates
- numberOfFrames:
    Number Of Frames
- numberOfCycles:
    Number Of Cycles
- timing:
    The timing mode of the detector
- acquisitionTime:
    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.
- triggerPeriod:
    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.
- detectorNumber:
    Returns the serial number of the module (normally the MAC address).
- detectorVersion:
    Returns the version of the controller firmware.
- softwareVersion:
    Returns the version of the software running on the detector.
- thisVersion:
    Returns the version of the control software which is being used.
- pollingInterval:
    The interval for polling the laser front-end for status.
- tempAdc:
    Returns the ADC temperature.
- tempFpga:
    Returns the FPGA temperature.
- detectorMac:
    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.
- rOnline:
    rOnline

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

###### RECEIVER

Instance id: | FXE_OGT1_SA/DET/RECEIVER
Class id: | GotthardReceiver
Host: | exflcon07n0
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-08-05T15:05:54.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.0-2.9.1
Deployment tag: | 1.8.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.

Release History
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.

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

##### ENC

###### CRYSTAL_THETA

Instance id: | FXE_OGT1_SA/ENC/CRYSTAL_THETA
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_X1

Instance id: | FXE_OGT1_SA/ENC/CRYSTAL_X1
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_X2

Instance id: | FXE_OGT1_SA/ENC/CRYSTAL_X2
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_Y

Instance id: | FXE_OGT1_SA/ENC/CRYSTAL_Y
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_SA, FXE_LOOP1, FXE_OGT1_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_Z

Instance id: | FXE_OGT1_SA/ENC/CRYSTAL_Z
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### ROD_IN_OUT

Instance id: | FXE_OGT1_SA/ENC/ROD_IN_OUT
Host: | exflcon07n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### CRYSTAL_THETA

Instance id: | FXE_OGT1_SA/MOTOR/CRYSTAL_THETA
Class id: | BeckhoffMC2Base
Host: | exflcon07n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT1_SA, FXE_LOOP1, FXE_OGT1_SA
Scenes: | FXE_OGT1_SA/MOTOR/CRYSTAL_THETA, FXE_OGT1_SA/MOTOR/CRYSTAL_THETA, FXE_OGT1_SA/MOTOR/CRYSTAL_THETA|motorScene, FXE_OGT1_SA/MOTOR/CRYSTAL_THETA|simpleMotorScene, FXE_OGT1_SA-MOTOR-CRYSTAL_THETA, FXE_OGT1_SA-MOTOR-CRYSTAL_THETA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### CRYSTAL_X1

Instance id: | FXE_OGT1_SA/MOTOR/CRYSTAL_X1
Class id: | BeckhoffMC2Base
Host: | exflcon07n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Scenes: | FXE_OGT1_SA/MOTOR/CRYSTAL_X1, FXE_OGT1_SA/MOTOR/CRYSTAL_X1|motorScene, FXE_OGT1_SA/MOTOR/CRYSTAL_X1, FXE_OGT1_SA-MOTOR-CRYSTAL_X1, FXE_OGT1_SA-MOTOR-CRYSTAL_X1, FXE_OGT1_SA/MOTOR/CRYSTAL_X1|simpleMotorScene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### CRYSTAL_X2

Instance id: | FXE_OGT1_SA/MOTOR/CRYSTAL_X2
Class id: | BeckhoffMC2Base
Host: | exflcon07n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT1_SA, FXE_LOOP1, FXE_OGT1_SA
Scenes: | FXE_OGT1_SA/MOTOR/CRYSTAL_X2, FXE_OGT1_SA/MOTOR/CRYSTAL_X2|simpleMotorScene, FXE_OGT1_SA/MOTOR/CRYSTAL_X2|motorScene, FXE_OGT1_SA/MOTOR/CRYSTAL_X2, FXE_OGT1_SA-MOTOR-CRYSTAL_X2, FXE_OGT1_SA-MOTOR-CRYSTAL_X2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### CRYSTAL_Y

Instance id: | FXE_OGT1_SA/MOTOR/CRYSTAL_Y
Class id: | BeckhoffMC2Base
Host: | exflcon07n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT1_SA, FXE_LOOP1, FXE_OGT1_SA
Scenes: | FXE_OGT1_SA/MOTOR/CRYSTAL_Y, FXE_OGT1_SA-MOTOR-CRYSTAL_Y, FXE_OGT1_SA/MOTOR/CRYSTAL_Y|motorScene, FXE_OGT1_SA-MOTOR-CRYSTAL_Y, FXE_OGT1_SA/MOTOR/CRYSTAL_Y|simpleMotorScene, FXE_OGT1_SA/MOTOR/CRYSTAL_Y
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### CRYSTAL_Z

Instance id: | FXE_OGT1_SA/MOTOR/CRYSTAL_Z
Class id: | BeckhoffMC2Base
Host: | exflcon07n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT1_SA, FXE_LOOP1, FXE_OGT1_SA
Scenes: | FXE_OGT1_SA/MOTOR/CRYSTAL_Z, FXE_OGT1_SA/MOTOR/CRYSTAL_Z|simpleMotorScene, FXE_OGT1_SA/MOTOR/CRYSTAL_Z|motorScene, FXE_OGT1_SA/MOTOR/CRYSTAL_Z, FXE_OGT1_SA-MOTOR-CRYSTAL_Z, FXE_OGT1_SA-MOTOR-CRYSTAL_Z
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### ROD_IN_OUT

Instance id: | FXE_OGT1_SA/MOTOR/ROD_IN_OUT
Class id: | BeckhoffMC2Base
Host: | exflcon07n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Scenes: | FXE_OGT1_SA/MOTOR/ROD_IN_OUT, FXE_OGT1_SA/MOTOR/ROD_IN_OUT|simpleMotorScene, FXE_OGT1_SA/MOTOR/ROD_IN_OUT|motorScene, FXE_OGT1_SA/MOTOR/ROD_IN_OUT, FXE_OGT1_SA-MOTOR-ROD_IN_OUT, FXE_OGT1_SA-MOTOR-ROD_IN_OUT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### AUX1

###### AUX2

###### BASE_X

###### CRYST_THETA

###### CRYST_X

###### CRYST_Y

###### DET_THETA

###### DET_X

##### SPEC

###### GOTTHARD

Instance id: | FXE_OGT1_SA/SPEC/GOTTHARD
Class id: | ImageToSpectrum
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
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
Scenes: | Gotthard_Calibration
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 to Spectrum

The `ImageToSpectrum` device is part of the imageProcessor package, and is documented in imageprocessor:image-to-spectrum-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
- frameRate:
    Rate of processed images.
- roi:
    The user-defined region of interest (ROI), specified as [lowX, highX, lowY, highY]. [0, 0, 0, 0] will be interpreted as ‘whole range’.
- xIntegral:
    Integrate the image in X direction. By default integral is done over Y.
- spectrumIntegral:
    Integral of the spectrum, after applying ROI.
- resetError:
    Reset error count.

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

##### TSENS

###### ROD_TEMP1

Instance id: | FXE_OGT1_SA/TSENS/ROD_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Scenes: | FXE_OGT1_SA/TSENS/ROD_TEMP1, FXE_OGT1_SA/TSENS/ROD_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD_TEMP2

Instance id: | FXE_OGT1_SA/TSENS/ROD_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Scenes: | FXE_OGT1_SA/TSENS/ROD_TEMP2, FXE_OGT1_SA/TSENS/ROD_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SA_TEMP

Instance id: | FXE_OGT1_SA/TSENS/SA_TEMP
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_SA, FXE_OGT1_SA, FXE_LOOP1
Scenes: | FXE_OGT1_SA/TSENS/SA_TEMP, FXE_OGT1_SA/TSENS/SA_TEMP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### CRYSTAL_SEL

Instance id: | FXE_OGT1_SA/MDL/CRYSTAL_SEL
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-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: | FXE_OGT1-SpA1_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
- 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
- moveC__111__:
    Moves the motor to the position marked with this label
- moveGe__111__:
    Moves the motor to the position marked with this label
- moveSi__110_:
    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: |

###### ORDER_SEL

Instance id: | FXE_OGT1_SA/MDL/ORDER_SEL
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-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: | FXE_OGT1-SpA1_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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- move0th_Order:
    Moves the motor to the position marked with this label
- move1st_Order:
    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: |

#### TAD

##### CAL

###### CONTROL-1

Instance id: | FXE_OGT1_TAD/CAL/CONTROL-1
Host: | exflcon06n0
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsCalibrator
Last modified: | 2019-08-12T13:16:18.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Danilevski, Baumann, Parenti
Latest tag: | 1.4.0-2.5.1
Deployment tag: | 1.4.0-2.5.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- _deviceId_:

    Do not set this property, it will be set by the device-server

- 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.

- _serverId_:

    Do not set this property, it will be set by the device-server

- 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 defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

    Do not set this property, it will be set by the device-server.

- pid:

    The unix process ID of the device

- 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:

    Calibrate actual position to calibrated position.

- availableScenes:

    Scenes from the Slit System

- _connection_:

    The connection to the communication layer of the distributed system

- useTimeserver:

    Unused - whether device connects to time server is configured via ‘timeServerId’

- progress:

    The progress of the current action

- 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:

    Reset error count.

- enableInterlockedSlots:

    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

- disableInterlockedSlots:

    Send device into INTERLOCKED state, thus enabling all interlocked slots.

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

- readHardware:

    Requests value updates from the PLC for the properties listed under ‘Properties to read’

- force:

    ???

- trigger:

    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.

- 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

- moveModulo:

- 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

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    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.

- topChannel:

    Please specify the ADC channel which correspond to Top

- bottomChannel:

    Please specify the ADC channel which correspond to Bottom

- leftChannel:

    Please specify the channel which correspond to Left

- rightChannel:

    Please specify the channel which correspond to Right

- calibrationFactorX:

    Calibration Factor to align beam position in x direction

- calibrationFactorY:

    Calibration Factor to align beam position in y direction

- upperBound:

    upper range of window to select desired pulses

- lowerBound:

    Lower range of window to select desired pulses

- temporalAverage:

    Average is evaluated over N last Trains

- numberOfPulses:

    Number of pulses per train

- pulseThreshold:

    Threshold to validate the pulse

- trainThreshold:

    Threshold to validate the train

- pulseValidity:

    True, if a value of all channels at a given pulses are greater than pulse threshold otherwise false

- trainValidity:

    True, if pulseValidity of all channels are greater than train threshold otherwise false

- quadrant:

    Quadrant

- scatterPosition:

    Scatter Position Node

- reconnectInterval:

    Reconnect Interval to DOOCS in case of ERROR

- location:

    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION

- updateInterval:

    Update interval.

- lockStatus:

    O: Locked - 1: NOT locked - 3: Unknown

- lock:

    lock

- unlock:

    Unlock the laser by setting the coarseTune to ID: 7

- 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

- stepLength:

    Step length used in Step Up/Step Down.

- zeroAngle:

    The position of the motor where the zero angle is defined

- offsetIntensity:

    Defines the lowest soft limit

- 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

- timeoutConnectToBCom:

    Timeout for succesfully connect to PLC

- timeoutReadDevConfig:

    Timeout for getting the same number of failures when reading the configuration of devices

- setDefaultDevConfig:

    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device

- outputFileRoot:

    Template string for output XML file

- inputFileTemplate:

    File with variables to save in FW

- configDir:

    Folder to store configuration files

- plcInFwTemplate:

    List of PLCs which have a specific configuration to save, as found in the FW Template

- instantiateDevices:

    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.

- instantiateQuick:

    Instantiate all devices on selected PLC quickly

- instantiateGroupDevices:

    Instantiate all selected group devices in selected PLC

- instantiateComponentDevices:

    Instantiate all selected component devices in selectedPLC

- resetDevices:

    Reset all devices in Error state

- getOfflineDevices:

    Check which devices are still offline

- shutdownDevices:

    Shutdown all devices

- shutdownGroupDevices:

    Shutdown all group devices

- shutdownComponentDevices:

    Shutdown all component devices

- getPLCsInFwTemplate:

    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.

- getPLCsInSystem:

    Get list of PLCs active in current topic

- handleMultiConfigToXML:

    The retrieved config of devices in PLCs is written on an XML file

- handleSingleConfigToXML:

    The retrieved config of devices in selected beckhoffId is written in XML file

- serverUri:

    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.

- serverTimeout:

    Timeout for server responses.

- autoResetTime:

    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.

- connectionSettlingTime:

    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- plcUptime:

    Total time (in seconds), that the PLC server is up and running

- createGenericDevices:

    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.

- messageRateOut:

    The average rate of messages sent by BeckhoffCom

- messageRateIn:

    The average rate of messages received by BeckhoffCom

- byteRateOut:

    The average rate of bytes sent by BeckhoffCom

- byteRateIn:

    The average rate of bytes received by BeckhoffCom

- availablePlcDevices:

    Lists all available PLC devices

- updatesRate:

    The average rate of updates to the Beckhoff Devices

- devicesBlacklist:

    List of the devices that will not be instantiated automatically.

- instantiationInterval:

    The interval between consecutive instantiations

- ACpuFrequency:

    Frequency of the CPU.

- ACurrentCpuUsage:

    Current CPU usage.

- ACurrentCpuTemperature:

    Current temperature of the CPU.

- AProgramMemoryAllocated:

    Allocated program memory.

- AProgramMemoryAvailable:

    Available program memory.

- AStorageMemoryAllocated:

    Allocated storage-memory. Available on Windows CE.

- AStorageMemoryAvailable:

    Available storage-memory. Available on Windows CE.

- AMemoryDivision:

    MemoryDivision. Available on Windows CE.

- AProgramMemoryAllocated2:

    Allocated program memory.

- AProgramMemoryAvailable2:

    Available program memory.

- AMacAddess:

    MAC-Address of the PLC (17 char string).

- AIpv4Address:

    Current IPv4 Address of the PLC in dotted notation (15 char string).

- AIpv4SubnetMask:

    IPv4 subnet mask of the PLC in dotted notation (15 char string).

- ADhcpServerIpv4Address:

    IP-Address of the DHCP-Server in dotted notation (15 char string).

- ADhcpServerEnabled:

    True if the DHCP-Server is enabled.

- AMainboardType:

    Type of the main-board.

- ASerialNumber:

    Serial number.

- AProductionDate:

    Production date of the main-board.

- ABootCount:

    Boot count.

- AOperatingTimeInMinutes:

    Operating time of the main-board.

- AMinBoardTemperature:

    Minimum temperature of the main-board.

- AMaxBoardTemperature:

    Maximum temperature of the main-board.

- MinInputVoltage:

    Minimum input voltage of the main-board.

- MaxInputVoltage:

    Maximum input voltage of the main-board.

- MainboardTemperature:

    Current temperature of the main-board.

- APlcProjectVersion:

    PLC Project Version

- AProjectGeneratorVersion:

    Project Generator Version

- ATCPBufferSize:

    TCP/IP buffer size.

- ATrainID:

    Train ID

- ABeamModes:

    Beam Modes

- ATCPOutputDataRate:

    TCP Output Data Rate

- ATCPOutputBufLvlMax:

    TCP Output Buf Lvl Max

- ATCPInputDataRate:

    TCP Input Data Rate

- ATCPInputBufLvlMax:

    TCP Input Buf Lvl Max

- APLCCycleTime:

    PLC Cycle Time

- ignore:

    Ignore

- configure:

    Upload configuration parameters to the FEM

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- lastStatusMessage:

    Status message of last command

- loggerConfig:

    Runtime logger configuration

- policy:

    Errors handling policy

- ApplicationMonitor:

    Application health monitor

- BookKeeper:

    Book keeper

- BufferManager:

    Buffer manager

- DataAccessor0:

    Data accessor 0

- DataAccessor1:

    Data accessor 1

- DataDispatcher:

    Data dispatcher

- DataIntegrator:

    Data integrator

- DataMonitor:

    Data content monitor

- FastDataCollector:

    Fast data collector

- Formatter:

    Formatter

- InternalTrigger:

    Internal trigger

- MessageLogger:

    Message logger

- PreProcessor:

    Pre processor

- Scheduler:

    Scheduler

- SlowDataCollector:

    Slow data collector

- StatisticsBuilder:

    Statistics builder

- Summarizer:

    Data summarizer

- TrainDataReceiver:

    Train data receiver

- TrainReconstructor:

    Train data reconstructor

- Vectorizer:

    Data vectorizer

- Writer:

    Writer

- enableDaqNode:

    Enable DAQ node

- storageManager:

    Storage manager device

- groupId:

    Aggregators group Id

- groupInfix:

    Aggregators group infix

- channelId:

    channel Id

- channelsCount:

    Number of channels

- mountPoint:

    Mount point

- dataPath:

    Proposal data path

- chunkSize:

    Number of trains to buffer in memory

- chunksCount:

    Chunk count per file

- maxExpectedPulses:

    Maximum number of pulses expected per train

- dataType:

    Data type

- runController:

    The deviceId of the RunController to use, starts and stops daq.

- experimentDetails:

    Experiment details

- sampleDetails:

    Sample details

- runDetails:

    Run details

- enableXTDF:

    Enable receiving train data via UDP

- OriginalDataFormat:

    Name of file that contains the original data format description, include train data format, dataset and run info.

- Detector:

    Name of file that contains the detector configuration.

- timeServerId:

    The instance id uniquely identifies a TimeServer instance in the distributed system

- Logger:

    Logging settings

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- 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

- group:

    Structure describing data sources logically belonging together.

- owner:

    The person to contact regarding usage of this group

- 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

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- createGrid:

    Create a parallelogram with the following input

    > steps_x, steps_y, v_bl=None, v_br=None, v_tl=None, v_tr=None, exclude=”topRight”

- 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

- 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:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- 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’.

- availableMacros:

    Provides scan macros from the scan device

- output:

    Output Channel for the scan data

- abort:

    Call this slot to stop everything

- pause:

    Call this slot to pause or resume running scan

- proxy:

    The Clock and Control device

- uploadOk:

    Was the upload to Veto Memory Successful

- displayedSequence:

    Sequence generated from user input

- displayedBinOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered

- displayedOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered, human readable

- vetoMode:

    The mode in which to generate the pattern.

- inputString:

    The input can be valid python code, that generates either an integer, or an iterable of integers. When doing equations, remember to cast your floats to ints.

- saveVetoPatternFile:

    Save VETO pattern to disk file, as configured in the CCMon device

- uploadPatternFile:

    Upload VETO pattern from file into VETO memory, as configured in the CCMon device, and check that the upload was correct

- deviceNames:

    The LpdFem devices to be sub-control

- connectFem:

    Open connection to FEM

- disconnectFem:

    Close connection to FEM

- prepare:

    Prepare new configuration parameters for the FEM

- startDAQ:

    Start data acquisition

- stopDAQ:

    Stop acquisition immediately

- sync_params:

    Sets all composite parameters on fems.

- manual_recover:

    Try recovery from UNKNOWN after state desynchronization has been manually solved for the respective children.

- asicPowerEnable0:

    ASIC 0 LV Power Enable

- asicPowerEnable1:

    ASIC 1 LV Power Enable

- asicRxGainAlgorithmType:

    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)

- asicRxGainThresholdx10:

    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- asicRxGainThresholdx100:

    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- cccEmulationMode:

    Enable to emulate Clock & Control commands (for testing in absence of C&C)

- cccProvideNumberImages:

    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages

- cccResetDelay:

    Adjust timing of reset (in steps of clock cycles)

- cccStopDelay:

    Adjust timing of the stop (in steps of clock cycles)

- cccSystemMode:

    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes

- cccVetoPatternFile:

    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)

- cccVetoStartDelay:

    Adjust timing of veto arrival (in steps of clock cycles)

- femAsicClockSource:

    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond

- femAsicCmdSequence:

    ASIC Command Words defined in XML syntax

- femAsicCommandLength:

    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz

- femAsicDataType:

    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom

- femAsicGain:

    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)

- femAsicPixelFeedbackOverride:

    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides

- femAsicPixelSelfTestOverride:

    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides

- femAsicSetupParams:

    ASIC Setup Parameters defined in XML syntax

- femInvertAdcData:

    Enable Invert ADC ASIC data True=Invert Data

- femPpcEmulatePipeline:

    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors

- femPpcImageReordering:

    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled

- femPpcMode:

    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout

- femStartTrainDelay:

    Delay between trigger arrival and start of train (in FEM clock cycles)

- femStartTrainInhibit:

    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout

- femStartTrainPolarity:

    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal

- femStartTrainSource:

    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond

- femVetoPolarity:

    Set polarity of the external veto signal 0=No inversion, 1=Invert signal

- integrationCycles:

    Sets the number of integration cycles per images

- numPulsesInTrainOverride:

    Length of XRay Pulse Train (number pulses)

- numberImages:

    Sets the number of images per trigger

- numberTrains:

    Number of trains [if LL Data Generator or PPC Data Direct selected]

- sensorBias0:

    Sensor 0 HV Bias Voltage [V]

- sensorBias1:

    Sensor 1 HV Bias Voltage [V]

- sensorBiasEnable0:

    Sensor 0 HV Bias Enable

- sensorBiasEnable1:

    Sensor 1 HV Bias Enable

- tenGigInterframeGap:

    10GigE Inter-frame gap timer [clock cycles]

- tenGigUdpPacketLen:

    10GigE UDP packet payload length

- timeoutTrain:

    Timeout in seconds on waiting for next Train during run

- trainGenInterval:

    Interval (in 100 mhz clock periods) between internally generated Train start commands

- proxyCACML:

    The Clock and Control device

- fem:

    Device controlling Fem, can be composite

- ccMon:

    Device controlling clock & control.

- data_taking:

    Detector Device That Implements TakeData Function.

- x2Timer:

    The utca device

- cancel:

    Cancels last button pressed.

- femBootUpTime:

    Time needed for FEM to be responsive after powering up [s].

- asicBootUpTime:

    Time needed for asics to follow last commands [s].

- powerTimeout:

    Time needed for power to arrive at all FEMS [s].

- configTimeout:

    Time needed for femComposit to upload config

- scenarioConfig:

    Configuration of common operation scenarios

- emergencyShutdown:

    Power off quadrants immediately.

- uploadConfig:

    Sends selected configuration to detector.

- getReady:

    Bring detector in a state ready for data taking

- startDisablePower:

    Disable LPDpower & …

- disable:

    Disable FEM to be ignored

- enable:

    Enable FEM to be part of the system

- disabled:

    Disable FEM, will no longer be controlled by the composite

- sys_status:

    Status summary

- error_msg:

    Error message.

- sync_start_time:

    Unix timestamp to trigger start at

- femHost:

    FEM hostname or IP address

- femPort:

    FEM port number

- femTimeout:

    FEM connection timeout

- femAsicModuleType:

    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone

- femLegacyPowerCard:

    Enable legacy power card support

- tenGig0SourceMac:

    10GigE 0 UDP Source MAC Address

- tenGig0SourceIp:

    10GigE 0 UDP Source IP Address

- tenGig0SourcePort:

    10GigE 0 UDP Source Port

- tenGig0DestMac:

    10GigE 0 UDP Destination MAC Address

- tenGig0DestIp:

    10GigE 0 UDP Destination IP Address

- tenGig0DestPort:

    10GigE 0 UDP Destination Port

- femEnableTenGig:

    Enables transmission of image data via 10GigE UDP interface

- femDataSource:

    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)

- femAsicEnableMask:

    ASIC RX channel enable mask (4*32 bits)

- femReadoutOperatingMode:

    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD

- femAsicLocalClock:

    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)

- femAsicSetupLoadMode:

    ASIC control load mode 0=parallel, 1=daisy chain (being tested)

- femAsicRxCmdWordStart:

    Enable ASIC readout started by Command Word in femAsicCmdSequence file

- femAsicSetupClockPhase:

    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset

- tenGigFarmMode:

    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists

- femAsicVersion:

    ASIC Version 1=version 1, 2=version 2

- femAsicGainOverride:

    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)

- femDebugLevel:

    Set the debug level

- tenGig0DataGenerator:

    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0DataFormat:

    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0FrameLength:

    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0NumberOfFrames:

    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]

- femModuleId:

    ID for FEM to differentiate from which FEM data is coming from 0 - 15

- femAsicTestDataPatternType:

    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image

- femTrainIdInitLsw:

    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker

- femTrainIdInitMsw:

    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker

- powerCardFault0:

    Power Card 0 Fault Flag

- powerCardFault1:

    Power Card 1 Fault Flag

- powerCardFemStatus0:

    Power Card 0 FEM Status Flag

- powerCardFemStatus1:

    Power Card 1 FEM Status Flag

- powerCardExtStatus0:

    Power Card 0 External Status Flag

- powerCardExtStatus1:

    Power Card 1 External Status Flag

- powerCardOverCurrent0:

    Power Card 0 Overcurrent Flag

- powerCardOverCurrent1:

    Power Card 1 Overcurrent Flag

- powerCardOverTemp0:

    Power Card Over 0 Temperature Flag

- powerCardOverTemp1:

    Power Card Over 1 Temperature Flag

- powerCardUnderTemp0:

    Power Card Under 0 Temperature Flag

- powerCardUnderTemp1:

    Power Card Under 1 Temperature Flag

- powerCardTemp0:

    Power Card 0 Temperature [C]

- powerCardTemp1:

    Power Card 1 Temperature [C]

- sensor0Temp:

    Sensor 0 Temperature [C]

- sensor1Temp:

    Sensor 1 Temperature [C]

- sensor2Temp:

    Sensor 2 Temperature [C]

- sensor3Temp:

    Sensor 3 Temperature [C]

- sensor4Temp:

    Sensor 4 Temperature [C]

- sensor5Temp:

    Sensor 5 Temperature [C]

- sensor6Temp:

    Sensor 6 Temperature [C]

- sensor7Temp:

    Sensor 7 Temperature [C]

- sensor8Temp:

    Sensor 8 Temperature [C]

- sensor9Temp:

    Sensor 9 Temperature [C]

- sensor10Temp:

    Sensor 10 Temperature [C]

- sensor11Temp:

    Sensor 11 Temperature [C]

- sensor12Temp:

    Sensor 12 Temperature [C]

- sensor13Temp:

    Sensor 13 Temperature [C]

- sensor14Temp:

    Sensor 14 Temperature [C]

- sensor15Temp:

    Sensor 15 Temperature [C]

- femVoltage0:

    FEM 5V Supply 0 Voltage [V]

- femVoltage1:

    FEM 5V Supply 1 Voltage [V]

- femCurrent0:

    FEM 5V Supply 0 Current [A]

- femCurrent1:

    FEM 5V Supply 1 Current [A]

- digitalVoltage0:

    ASIC 1.2V Digital Supply 0 Voltage [V]

- digitalVoltage1:

    ASIC 1.2V Digital Supply 1 Voltage [V]

- digitalCurrent0:

    ASIC 1.2V Digital Supply 0 Current [mA]

- digitalCurrent1:

    ASIC 1.2V Digital Supply 1 Current [mA]

- sensor0Voltage:

    Sensor 0 3.3V Supply Voltage [V]

- sensor1Voltage:

    Sensor 1 3.3V Supply Voltage [V]

- sensor2Voltage:

    Sensor 2 3.3V Supply Voltage [V]

- sensor3Voltage:

    Sensor 3 3.3V Supply Voltage [V]

- sensor4Voltage:

    Sensor 4 3.3V Supply Voltage [V]

- sensor5Voltage:

    Sensor 5 3.3V Supply Voltage [V]

- sensor6Voltage:

    Sensor 6 3.3V Supply Voltage [V]

- sensor7Voltage:

    Sensor 7 3.3V Supply Voltage [V]

- sensor8Voltage:

    Sensor 8 3.3V Supply Voltage [V]

- sensor9Voltage:

    Sensor 9 3.3V Supply Voltage [V]

- sensor10Voltage:

    Sensor 10 3.3V Supply Voltage [V]

- sensor11Voltage:

    Sensor 11 3.3V Supply Voltage [V]

- sensor12Voltage:

    Sensor 12 3.3V Supply Voltage [V]

- sensor13Voltage:

    Sensor 13 3.3V Supply Voltage [V]

- sensor14Voltage:

    Sensor 14 3.3V Supply Voltage [V]

- sensor15Voltage:

    Sensor 15 3.3V Supply Voltage [V]

- sensor0Current:

    Sensor 0 3.3V Supply Current [A]

- sensor1Current:

    Sensor 1 3.3V Supply Current [A]

- sensor2Current:

    Sensor 2 3.3V Supply Current [A]

- sensor3Current:

    Sensor 3 3.3V Supply Current [A]

- sensor4Current:

    Sensor 4 3.3V Supply Current [A]

- sensor5Current:

    Sensor 5 3.3V Supply Current [A]

- sensor6Current:

    Sensor 6 3.3V Supply Current [A]

- sensor7Current:

    Sensor 7 3.3V Supply Current [A]

- sensor8Current:

    Sensor 8 3.3V Supply Current [A]

- sensor9Current:

    Sensor 9 3.3V Supply Current [A]

- sensor10Current:

    Sensor 10 3.3V Supply Current [A]

- sensor11Current:

    Sensor 11 3.3V Supply Current [A]

- sensor12Current:

    Sensor 12 3.3V Supply Current [A]

- sensor13Current:

    Sensor 13 3.3V Supply Current [A]

- sensor14Current:

    Sensor 14 3.3V Supply Current [A]

- sensor15Current:

    Sensor 15 3.3V Supply Current [A]

- sensorBiasVoltage0:

    Sensor bias 0 voltage readback [V]

- sensorBiasVoltage1:

    Sensor bias 1 voltage readback [V]

- sensorBiasCurrent0:

    Sensor bias 0 current readback [uA]

- sensorBiasCurrent1:

    Sensor bias 1 current readback [uA]

- femV5FirmwareVersion:

    FEM V5 Firmware Version

- femBotSp3FirmwareVersion:

    FEM Bottom SP3 FPGA Firmware Version

- femTopSp3FirmwareVersion:

    FEM Top SP3 FPGA Firmware Version

- femCfgSp3FirmwareVersion:

    FEM Config SP3 FPGA Firmware Version

- femLpdClientVersion:

    LpdFemClient Software Version - Read Only

- femReadoutActive:

    FEM readout is active

- femBoardTemperature:

    FEM Board Sensor Temperature [C] Reading

- femCoreTemperature:

    FEM Core Sensor Temperature [C] Reading

- auto_mode:

    Configure default configuration when taking darks

- take_dark_frames:

    Take set of dark frames.

- startScan:

    Value with which to start scan.

- stopScan:

    Value around which to stop scan. Depends on start value and step size if it is reached exactly.

- nSteps:

    Number of steps in the intervall between start and stop.

- optWithCCMon:

    To choose delay scan with or without C&C

- delayScanSleepTime:

    Time needed for X2Timer to delay scan with C&C [s].

- delayScan:

    Start delay scan.

- runControl:

    Device controlling run management.

- self_check:

    Check if all conditions are ok for data taking.

- control:

    Control of system variables

- powerEnable:

    Allow all quadrants to receive power.

- powerDisable:

    Forbid all quadrants to receive power.

- armInterlock:

    Arm interlock to be able to power quadrants.

- disarmInterlock:

    Disarm interlock, no power allowed to quadrants.

- quad1:

    Quad1 node

- quad4:

    Quad4 node

- quad2:

    Quad2 node

- quad3:

    Quad3 node

- temperature:

    Camera temperature. Not available for all models.

- humidity:

    Humidity sensors

- leakimpedance:

    Leak sensors

- pump:

    Pump variables

- fan:

    Fan variables

- 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

- 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

- value:

    Analog input of ADC.

- semiRawValue:

    Semi raw value of analog input, i.e. the voltage.

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- relativeEpsilon:

    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- frameRate:

    Rate of processed images.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- extractedLabels:

    Out positions: labels, where the imager is extracted from the beam.

- tolerance:

    Position tolerance for increment detection

- moveOUT:

    Moves the motor to the position marked with this label

- moveC:

    Moves the motor to the position marked with this label

- moveC/:

    Moves the motor to the position marked with this label

- moveYAG:

    Moves the motor to the position marked with this label

- useAsBackgroundImage:

    Use the current image as background image.

- filterImagesByThreshold:

    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

- imageThreshold:

    The threshold for processing an image.

- absolutePositions:

    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

- subtractBkgImage:

    Subtract the loaded background image.

- subtractImagePedestal:

    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

- doMinMaxMean:

    Get the following information from the pixels: min, max, mean value.

- doBinCount:

    Calculate the frequency distribution of pixel values.

- doXYSum:

    Integrate the image along the x- and y-axes.

- doCOfM:

    Calculate centre-of-mass and widths.

- do1DFit:

    Perform a 1D gaussian fit of the x- and y-distributions.

- do2DFit:

    Perform a 2D gaussian fits.Be careful: It can be slow!

- doIntegration:

    Perform integration over region.

- clipValues:

    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

- comRange:

    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

- userDefinedRange:

    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- absThreshold:

    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

- threshold:

    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

- pixelSize:

    The pixel size. It will be used when evaluating the beam size.

- fitRange:

    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

- rangeForAuto:

    The automatic range for ‘auto’ mode (in standard deviations).

- enablePolynomial:

    Add a 1st order polynomial term (ramp) to gaussian fits.

- gauss1dStartValues:

    Selects how 1D gauss fit starting values are evaluated

- doGaussRotation:

    Allow the 2D gaussian to be rotated.

- integrationRegion:

    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- thresholdRange:

    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

- imageWidth:

    The width of the incoming image.

- imageOffsetX:

    If the incoming image has a ROI, this represents the X position of the top-left corner.

- imageBinningX:

    The image binning in the X direction.

- imageHeight:

    The height of the incoming image. Set to 1 for 1D images (spectra).

- imageOffsetY:

    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

- imageBinningY:

    The image binning in the Y direction. Set to 1 for 1D images (spectra).

- minPxValue:

    The minimum image pixel value.

- maxPxValue:

    The maximum image pixel value.

- meanPxValue:

    The mean image pixel value.

- minMaxMeanTime:

    Time spent for evaluating min, max, mean pixel value.

- binCountTime:

    Time spent for calculating the frequency distribution of pixel values.

- subtractBkgImageTime:

    Time spent in subtracting the background image.

- subtractPedestalTime:

    Time spent in subtracting the image pedestal.

- xYSumTime:

    Time spent in integrating the image in X and Y.

- cOfMTime:

    Time spent in evaluating the centre-of-mass.

- xFitTime:

    Time spent in 1D Gaussian fit of the X distribution.

- yFitTime:

    Time spent in 1D Gaussian fit of the Y distribution.

- fitTime:

    Time spent in 2D Gaussian fit of the image.

- integrationTime:

    Time spent in integrating over a region.

- x0:

    X position of the centre-of-mass.

- sx:

    Standard deviation in X of the centre-of-mass.

- y0:

    Y position of the centre-of-mass.

- sy:

    Standard deviation in Y of the centre-of-mass.

- xFitSuccess:

    1D Gaussian fit success (1-4 if fit converged).

- ax1d:

    Amplitude Ax from the 1D fit.

- x01d:

    x0 from 1D Fit.

- ex01d:

    Uncertainty on x0 estimation.

- sx1d:

    Standard deviation on x0 from 1D fit.

- esx1d:

    Uncertainty on standard deviation estimation.

- beamWidth1d:

    Beam width from 1D Fit. Defined as 4x sigma_x.

- yFitSuccess:

    1D Gaussian Fit Success (1-4 if fit converged).

- ay1d:

    Amplitude Ay from 1D fit.

- y01d:

    y0 from 1D Fit.

- ey01d:

    Uncertainty on y0 estimation.

- sy1d:

    Standard deviation on y0 from 1D fit.

- esy1d:

    Uncertainty on standard deviation estimation.

- beamHeight1d:

    Beam heigth from 1D Fit. Defined as 4x sigma_y.

- fitSuccess:

    2D Gaussian fit success (1-4 if fit converged).

- a2d:

    Amplitude from 2D fit.

- x02d:

    x0 from 2D Fit.

- ex02d:

    Uncertainty on x0 estimation.

- sx2d:

    Standard deviation on x0 from 2D fit.

- esx2d:

    Uncertainty on standard deviation estimation.

- beamWidth2d:

    Beam width from 2D Fit. Defined as 4x sigma_x.

- y02d:

    y0 from 2D Fit.

- ey02d:

    Uncertainty on y0 estimation.

- sy2d:

    Standard deviation on y0 from 2D fit.

- esy2d:

    Uncertainty on standard deviation estimation.

- beamHeight2d:

    Beam height from 2D Fit. Defined as 4x sigma_y.

- theta2d:

    Rotation angle from 2D fit.

- etheta2d:

    Uncertainty on rotation angle estimation.

- regionIntegral:

    Integral of pixel value over region specified by integrationRegion.

- regionMean:

    Mean pixel value over region specified by integrationRegion.

- moveC1:

    Moves the motor to the position marked with this label

- moveC2:

    Moves the motor to the position marked with this label

- bkg:

    The background on ADC counts.

- cal:

    The calibration constants [keV/counts].

- averagedDisplay:

    Average all the frames in the train and then display.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.

- useBackgroundFrame:

    Use Frame for Background subtraction

- frameNumber:

    The index of the frame to be used for background subtraction

- errorCount:

    Number of errors.

- 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.

- onlineDisplayEnable:

    Enable online display of detector data.

- 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

- 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)

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- roi:

    The user-defined region of interest (ROI), specified as [lowX, highX, lowY, highY]. [0, 0, 0, 0] will be interpreted as ‘whole range’.

- xIntegral:

    Integrate the image in X direction. By default integral is done over Y.

- spectrumIntegral:

    Integral of the spectrum, after applying ROI.

Release History
1.4.0-2.5.1

Created: | 2019-08-08T13:22:44.000Z
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T12:31:43.000Z
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T10:01:40.000Z
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T12:58:56.000Z
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T08:34:30.000Z
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T13:50:05.000Z
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T10:28:08.000Z
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T16:29:31.000Z
Author: | Andrea Parenti
Notes: |

###### CONTROL-2

Instance id: | FXE_OGT1_TAD/CAL/CONTROL-2
Host: | exflcon06n0
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsCalibrator
Last modified: | 2019-08-12T13:16:18.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Danilevski, Baumann, Parenti
Latest tag: | 1.4.0-2.5.1
Deployment tag: | 1.4.0-2.5.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- _deviceId_:

    Do not set this property, it will be set by the device-server

- 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.

- _serverId_:

    Do not set this property, it will be set by the device-server

- 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 defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

    Do not set this property, it will be set by the device-server.

- pid:

    The unix process ID of the device

- 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:

    Calibrate actual position to calibrated position.

- availableScenes:

    Scenes from the Slit System

- _connection_:

    The connection to the communication layer of the distributed system

- useTimeserver:

    Unused - whether device connects to time server is configured via ‘timeServerId’

- progress:

    The progress of the current action

- 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:

    Reset error count.

- enableInterlockedSlots:

    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

- disableInterlockedSlots:

    Send device into INTERLOCKED state, thus enabling all interlocked slots.

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

- readHardware:

    Requests value updates from the PLC for the properties listed under ‘Properties to read’

- force:

    ???

- trigger:

    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.

- 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

- moveModulo:

- 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

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    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.

- topChannel:

    Please specify the ADC channel which correspond to Top

- bottomChannel:

    Please specify the ADC channel which correspond to Bottom

- leftChannel:

    Please specify the channel which correspond to Left

- rightChannel:

    Please specify the channel which correspond to Right

- calibrationFactorX:

    Calibration Factor to align beam position in x direction

- calibrationFactorY:

    Calibration Factor to align beam position in y direction

- upperBound:

    upper range of window to select desired pulses

- lowerBound:

    Lower range of window to select desired pulses

- temporalAverage:

    Average is evaluated over N last Trains

- numberOfPulses:

    Number of pulses per train

- pulseThreshold:

    Threshold to validate the pulse

- trainThreshold:

    Threshold to validate the train

- pulseValidity:

    True, if a value of all channels at a given pulses are greater than pulse threshold otherwise false

- trainValidity:

    True, if pulseValidity of all channels are greater than train threshold otherwise false

- quadrant:

    Quadrant

- scatterPosition:

    Scatter Position Node

- reconnectInterval:

    Reconnect Interval to DOOCS in case of ERROR

- location:

    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION

- updateInterval:

    Update interval.

- lockStatus:

    O: Locked - 1: NOT locked - 3: Unknown

- lock:

    lock

- unlock:

    Unlock the laser by setting the coarseTune to ID: 7

- 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

- stepLength:

    Step length used in Step Up/Step Down.

- zeroAngle:

    The position of the motor where the zero angle is defined

- offsetIntensity:

    Defines the lowest soft limit

- 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

- timeoutConnectToBCom:

    Timeout for succesfully connect to PLC

- timeoutReadDevConfig:

    Timeout for getting the same number of failures when reading the configuration of devices

- setDefaultDevConfig:

    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device

- outputFileRoot:

    Template string for output XML file

- inputFileTemplate:

    File with variables to save in FW

- configDir:

    Folder to store configuration files

- plcInFwTemplate:

    List of PLCs which have a specific configuration to save, as found in the FW Template

- instantiateDevices:

    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.

- instantiateQuick:

    Instantiate all devices on selected PLC quickly

- instantiateGroupDevices:

    Instantiate all selected group devices in selected PLC

- instantiateComponentDevices:

    Instantiate all selected component devices in selectedPLC

- resetDevices:

    Reset all devices in Error state

- getOfflineDevices:

    Check which devices are still offline

- shutdownDevices:

    Shutdown all devices

- shutdownGroupDevices:

    Shutdown all group devices

- shutdownComponentDevices:

    Shutdown all component devices

- getPLCsInFwTemplate:

    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.

- getPLCsInSystem:

    Get list of PLCs active in current topic

- handleMultiConfigToXML:

    The retrieved config of devices in PLCs is written on an XML file

- handleSingleConfigToXML:

    The retrieved config of devices in selected beckhoffId is written in XML file

- serverUri:

    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.

- serverTimeout:

    Timeout for server responses.

- autoResetTime:

    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.

- connectionSettlingTime:

    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- plcUptime:

    Total time (in seconds), that the PLC server is up and running

- createGenericDevices:

    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.

- messageRateOut:

    The average rate of messages sent by BeckhoffCom

- messageRateIn:

    The average rate of messages received by BeckhoffCom

- byteRateOut:

    The average rate of bytes sent by BeckhoffCom

- byteRateIn:

    The average rate of bytes received by BeckhoffCom

- availablePlcDevices:

    Lists all available PLC devices

- updatesRate:

    The average rate of updates to the Beckhoff Devices

- devicesBlacklist:

    List of the devices that will not be instantiated automatically.

- instantiationInterval:

    The interval between consecutive instantiations

- ACpuFrequency:

    Frequency of the CPU.

- ACurrentCpuUsage:

    Current CPU usage.

- ACurrentCpuTemperature:

    Current temperature of the CPU.

- AProgramMemoryAllocated:

    Allocated program memory.

- AProgramMemoryAvailable:

    Available program memory.

- AStorageMemoryAllocated:

    Allocated storage-memory. Available on Windows CE.

- AStorageMemoryAvailable:

    Available storage-memory. Available on Windows CE.

- AMemoryDivision:

    MemoryDivision. Available on Windows CE.

- AProgramMemoryAllocated2:

    Allocated program memory.

- AProgramMemoryAvailable2:

    Available program memory.

- AMacAddess:

    MAC-Address of the PLC (17 char string).

- AIpv4Address:

    Current IPv4 Address of the PLC in dotted notation (15 char string).

- AIpv4SubnetMask:

    IPv4 subnet mask of the PLC in dotted notation (15 char string).

- ADhcpServerIpv4Address:

    IP-Address of the DHCP-Server in dotted notation (15 char string).

- ADhcpServerEnabled:

    True if the DHCP-Server is enabled.

- AMainboardType:

    Type of the main-board.

- ASerialNumber:

    Serial number.

- AProductionDate:

    Production date of the main-board.

- ABootCount:

    Boot count.

- AOperatingTimeInMinutes:

    Operating time of the main-board.

- AMinBoardTemperature:

    Minimum temperature of the main-board.

- AMaxBoardTemperature:

    Maximum temperature of the main-board.

- MinInputVoltage:

    Minimum input voltage of the main-board.

- MaxInputVoltage:

    Maximum input voltage of the main-board.

- MainboardTemperature:

    Current temperature of the main-board.

- APlcProjectVersion:

    PLC Project Version

- AProjectGeneratorVersion:

    Project Generator Version

- ATCPBufferSize:

    TCP/IP buffer size.

- ATrainID:

    Train ID

- ABeamModes:

    Beam Modes

- ATCPOutputDataRate:

    TCP Output Data Rate

- ATCPOutputBufLvlMax:

    TCP Output Buf Lvl Max

- ATCPInputDataRate:

    TCP Input Data Rate

- ATCPInputBufLvlMax:

    TCP Input Buf Lvl Max

- APLCCycleTime:

    PLC Cycle Time

- ignore:

    Ignore

- configure:

    Upload configuration parameters to the FEM

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- lastStatusMessage:

    Status message of last command

- loggerConfig:

    Runtime logger configuration

- policy:

    Errors handling policy

- ApplicationMonitor:

    Application health monitor

- BookKeeper:

    Book keeper

- BufferManager:

    Buffer manager

- DataAccessor0:

    Data accessor 0

- DataAccessor1:

    Data accessor 1

- DataDispatcher:

    Data dispatcher

- DataIntegrator:

    Data integrator

- DataMonitor:

    Data content monitor

- FastDataCollector:

    Fast data collector

- Formatter:

    Formatter

- InternalTrigger:

    Internal trigger

- MessageLogger:

    Message logger

- PreProcessor:

    Pre processor

- Scheduler:

    Scheduler

- SlowDataCollector:

    Slow data collector

- StatisticsBuilder:

    Statistics builder

- Summarizer:

    Data summarizer

- TrainDataReceiver:

    Train data receiver

- TrainReconstructor:

    Train data reconstructor

- Vectorizer:

    Data vectorizer

- Writer:

    Writer

- enableDaqNode:

    Enable DAQ node

- storageManager:

    Storage manager device

- groupId:

    Aggregators group Id

- groupInfix:

    Aggregators group infix

- channelId:

    channel Id

- channelsCount:

    Number of channels

- mountPoint:

    Mount point

- dataPath:

    Proposal data path

- chunkSize:

    Number of trains to buffer in memory

- chunksCount:

    Chunk count per file

- maxExpectedPulses:

    Maximum number of pulses expected per train

- dataType:

    Data type

- runController:

    The deviceId of the RunController to use, starts and stops daq.

- experimentDetails:

    Experiment details

- sampleDetails:

    Sample details

- runDetails:

    Run details

- enableXTDF:

    Enable receiving train data via UDP

- OriginalDataFormat:

    Name of file that contains the original data format description, include train data format, dataset and run info.

- Detector:

    Name of file that contains the detector configuration.

- timeServerId:

    The instance id uniquely identifies a TimeServer instance in the distributed system

- Logger:

    Logging settings

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- 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

- group:

    Structure describing data sources logically belonging together.

- owner:

    The person to contact regarding usage of this group

- 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

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- createGrid:

    Create a parallelogram with the following input

    > steps_x, steps_y, v_bl=None, v_br=None, v_tl=None, v_tr=None, exclude=”topRight”

- 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

- 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:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- 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’.

- availableMacros:

    Provides scan macros from the scan device

- output:

    Output Channel for the scan data

- abort:

    Call this slot to stop everything

- pause:

    Call this slot to pause or resume running scan

- proxy:

    The Clock and Control device

- uploadOk:

    Was the upload to Veto Memory Successful

- displayedSequence:

    Sequence generated from user input

- displayedBinOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered

- displayedOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered, human readable

- vetoMode:

    The mode in which to generate the pattern.

- inputString:

    The input can be valid python code, that generates either an integer, or an iterable of integers. When doing equations, remember to cast your floats to ints.

- saveVetoPatternFile:

    Save VETO pattern to disk file, as configured in the CCMon device

- uploadPatternFile:

    Upload VETO pattern from file into VETO memory, as configured in the CCMon device, and check that the upload was correct

- deviceNames:

    The LpdFem devices to be sub-control

- connectFem:

    Open connection to FEM

- disconnectFem:

    Close connection to FEM

- prepare:

    Prepare new configuration parameters for the FEM

- startDAQ:

    Start data acquisition

- stopDAQ:

    Stop acquisition immediately

- sync_params:

    Sets all composite parameters on fems.

- manual_recover:

    Try recovery from UNKNOWN after state desynchronization has been manually solved for the respective children.

- asicPowerEnable0:

    ASIC 0 LV Power Enable

- asicPowerEnable1:

    ASIC 1 LV Power Enable

- asicRxGainAlgorithmType:

    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)

- asicRxGainThresholdx10:

    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- asicRxGainThresholdx100:

    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- cccEmulationMode:

    Enable to emulate Clock & Control commands (for testing in absence of C&C)

- cccProvideNumberImages:

    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages

- cccResetDelay:

    Adjust timing of reset (in steps of clock cycles)

- cccStopDelay:

    Adjust timing of the stop (in steps of clock cycles)

- cccSystemMode:

    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes

- cccVetoPatternFile:

    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)

- cccVetoStartDelay:

    Adjust timing of veto arrival (in steps of clock cycles)

- femAsicClockSource:

    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond

- femAsicCmdSequence:

    ASIC Command Words defined in XML syntax

- femAsicCommandLength:

    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz

- femAsicDataType:

    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom

- femAsicGain:

    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)

- femAsicPixelFeedbackOverride:

    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides

- femAsicPixelSelfTestOverride:

    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides

- femAsicSetupParams:

    ASIC Setup Parameters defined in XML syntax

- femInvertAdcData:

    Enable Invert ADC ASIC data True=Invert Data

- femPpcEmulatePipeline:

    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors

- femPpcImageReordering:

    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled

- femPpcMode:

    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout

- femStartTrainDelay:

    Delay between trigger arrival and start of train (in FEM clock cycles)

- femStartTrainInhibit:

    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout

- femStartTrainPolarity:

    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal

- femStartTrainSource:

    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond

- femVetoPolarity:

    Set polarity of the external veto signal 0=No inversion, 1=Invert signal

- integrationCycles:

    Sets the number of integration cycles per images

- numPulsesInTrainOverride:

    Length of XRay Pulse Train (number pulses)

- numberImages:

    Sets the number of images per trigger

- numberTrains:

    Number of trains [if LL Data Generator or PPC Data Direct selected]

- sensorBias0:

    Sensor 0 HV Bias Voltage [V]

- sensorBias1:

    Sensor 1 HV Bias Voltage [V]

- sensorBiasEnable0:

    Sensor 0 HV Bias Enable

- sensorBiasEnable1:

    Sensor 1 HV Bias Enable

- tenGigInterframeGap:

    10GigE Inter-frame gap timer [clock cycles]

- tenGigUdpPacketLen:

    10GigE UDP packet payload length

- timeoutTrain:

    Timeout in seconds on waiting for next Train during run

- trainGenInterval:

    Interval (in 100 mhz clock periods) between internally generated Train start commands

- proxyCACML:

    The Clock and Control device

- fem:

    Device controlling Fem, can be composite

- ccMon:

    Device controlling clock & control.

- data_taking:

    Detector Device That Implements TakeData Function.

- x2Timer:

    The utca device

- cancel:

    Cancels last button pressed.

- femBootUpTime:

    Time needed for FEM to be responsive after powering up [s].

- asicBootUpTime:

    Time needed for asics to follow last commands [s].

- powerTimeout:

    Time needed for power to arrive at all FEMS [s].

- configTimeout:

    Time needed for femComposit to upload config

- scenarioConfig:

    Configuration of common operation scenarios

- emergencyShutdown:

    Power off quadrants immediately.

- uploadConfig:

    Sends selected configuration to detector.

- getReady:

    Bring detector in a state ready for data taking

- startDisablePower:

    Disable LPDpower & …

- disable:

    Disable FEM to be ignored

- enable:

    Enable FEM to be part of the system

- disabled:

    Disable FEM, will no longer be controlled by the composite

- sys_status:

    Status summary

- error_msg:

    Error message.

- sync_start_time:

    Unix timestamp to trigger start at

- femHost:

    FEM hostname or IP address

- femPort:

    FEM port number

- femTimeout:

    FEM connection timeout

- femAsicModuleType:

    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone

- femLegacyPowerCard:

    Enable legacy power card support

- tenGig0SourceMac:

    10GigE 0 UDP Source MAC Address

- tenGig0SourceIp:

    10GigE 0 UDP Source IP Address

- tenGig0SourcePort:

    10GigE 0 UDP Source Port

- tenGig0DestMac:

    10GigE 0 UDP Destination MAC Address

- tenGig0DestIp:

    10GigE 0 UDP Destination IP Address

- tenGig0DestPort:

    10GigE 0 UDP Destination Port

- femEnableTenGig:

    Enables transmission of image data via 10GigE UDP interface

- femDataSource:

    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)

- femAsicEnableMask:

    ASIC RX channel enable mask (4*32 bits)

- femReadoutOperatingMode:

    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD

- femAsicLocalClock:

    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)

- femAsicSetupLoadMode:

    ASIC control load mode 0=parallel, 1=daisy chain (being tested)

- femAsicRxCmdWordStart:

    Enable ASIC readout started by Command Word in femAsicCmdSequence file

- femAsicSetupClockPhase:

    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset

- tenGigFarmMode:

    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists

- femAsicVersion:

    ASIC Version 1=version 1, 2=version 2

- femAsicGainOverride:

    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)

- femDebugLevel:

    Set the debug level

- tenGig0DataGenerator:

    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0DataFormat:

    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0FrameLength:

    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0NumberOfFrames:

    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]

- femModuleId:

    ID for FEM to differentiate from which FEM data is coming from 0 - 15

- femAsicTestDataPatternType:

    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image

- femTrainIdInitLsw:

    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker

- femTrainIdInitMsw:

    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker

- powerCardFault0:

    Power Card 0 Fault Flag

- powerCardFault1:

    Power Card 1 Fault Flag

- powerCardFemStatus0:

    Power Card 0 FEM Status Flag

- powerCardFemStatus1:

    Power Card 1 FEM Status Flag

- powerCardExtStatus0:

    Power Card 0 External Status Flag

- powerCardExtStatus1:

    Power Card 1 External Status Flag

- powerCardOverCurrent0:

    Power Card 0 Overcurrent Flag

- powerCardOverCurrent1:

    Power Card 1 Overcurrent Flag

- powerCardOverTemp0:

    Power Card Over 0 Temperature Flag

- powerCardOverTemp1:

    Power Card Over 1 Temperature Flag

- powerCardUnderTemp0:

    Power Card Under 0 Temperature Flag

- powerCardUnderTemp1:

    Power Card Under 1 Temperature Flag

- powerCardTemp0:

    Power Card 0 Temperature [C]

- powerCardTemp1:

    Power Card 1 Temperature [C]

- sensor0Temp:

    Sensor 0 Temperature [C]

- sensor1Temp:

    Sensor 1 Temperature [C]

- sensor2Temp:

    Sensor 2 Temperature [C]

- sensor3Temp:

    Sensor 3 Temperature [C]

- sensor4Temp:

    Sensor 4 Temperature [C]

- sensor5Temp:

    Sensor 5 Temperature [C]

- sensor6Temp:

    Sensor 6 Temperature [C]

- sensor7Temp:

    Sensor 7 Temperature [C]

- sensor8Temp:

    Sensor 8 Temperature [C]

- sensor9Temp:

    Sensor 9 Temperature [C]

- sensor10Temp:

    Sensor 10 Temperature [C]

- sensor11Temp:

    Sensor 11 Temperature [C]

- sensor12Temp:

    Sensor 12 Temperature [C]

- sensor13Temp:

    Sensor 13 Temperature [C]

- sensor14Temp:

    Sensor 14 Temperature [C]

- sensor15Temp:

    Sensor 15 Temperature [C]

- femVoltage0:

    FEM 5V Supply 0 Voltage [V]

- femVoltage1:

    FEM 5V Supply 1 Voltage [V]

- femCurrent0:

    FEM 5V Supply 0 Current [A]

- femCurrent1:

    FEM 5V Supply 1 Current [A]

- digitalVoltage0:

    ASIC 1.2V Digital Supply 0 Voltage [V]

- digitalVoltage1:

    ASIC 1.2V Digital Supply 1 Voltage [V]

- digitalCurrent0:

    ASIC 1.2V Digital Supply 0 Current [mA]

- digitalCurrent1:

    ASIC 1.2V Digital Supply 1 Current [mA]

- sensor0Voltage:

    Sensor 0 3.3V Supply Voltage [V]

- sensor1Voltage:

    Sensor 1 3.3V Supply Voltage [V]

- sensor2Voltage:

    Sensor 2 3.3V Supply Voltage [V]

- sensor3Voltage:

    Sensor 3 3.3V Supply Voltage [V]

- sensor4Voltage:

    Sensor 4 3.3V Supply Voltage [V]

- sensor5Voltage:

    Sensor 5 3.3V Supply Voltage [V]

- sensor6Voltage:

    Sensor 6 3.3V Supply Voltage [V]

- sensor7Voltage:

    Sensor 7 3.3V Supply Voltage [V]

- sensor8Voltage:

    Sensor 8 3.3V Supply Voltage [V]

- sensor9Voltage:

    Sensor 9 3.3V Supply Voltage [V]

- sensor10Voltage:

    Sensor 10 3.3V Supply Voltage [V]

- sensor11Voltage:

    Sensor 11 3.3V Supply Voltage [V]

- sensor12Voltage:

    Sensor 12 3.3V Supply Voltage [V]

- sensor13Voltage:

    Sensor 13 3.3V Supply Voltage [V]

- sensor14Voltage:

    Sensor 14 3.3V Supply Voltage [V]

- sensor15Voltage:

    Sensor 15 3.3V Supply Voltage [V]

- sensor0Current:

    Sensor 0 3.3V Supply Current [A]

- sensor1Current:

    Sensor 1 3.3V Supply Current [A]

- sensor2Current:

    Sensor 2 3.3V Supply Current [A]

- sensor3Current:

    Sensor 3 3.3V Supply Current [A]

- sensor4Current:

    Sensor 4 3.3V Supply Current [A]

- sensor5Current:

    Sensor 5 3.3V Supply Current [A]

- sensor6Current:

    Sensor 6 3.3V Supply Current [A]

- sensor7Current:

    Sensor 7 3.3V Supply Current [A]

- sensor8Current:

    Sensor 8 3.3V Supply Current [A]

- sensor9Current:

    Sensor 9 3.3V Supply Current [A]

- sensor10Current:

    Sensor 10 3.3V Supply Current [A]

- sensor11Current:

    Sensor 11 3.3V Supply Current [A]

- sensor12Current:

    Sensor 12 3.3V Supply Current [A]

- sensor13Current:

    Sensor 13 3.3V Supply Current [A]

- sensor14Current:

    Sensor 14 3.3V Supply Current [A]

- sensor15Current:

    Sensor 15 3.3V Supply Current [A]

- sensorBiasVoltage0:

    Sensor bias 0 voltage readback [V]

- sensorBiasVoltage1:

    Sensor bias 1 voltage readback [V]

- sensorBiasCurrent0:

    Sensor bias 0 current readback [uA]

- sensorBiasCurrent1:

    Sensor bias 1 current readback [uA]

- femV5FirmwareVersion:

    FEM V5 Firmware Version

- femBotSp3FirmwareVersion:

    FEM Bottom SP3 FPGA Firmware Version

- femTopSp3FirmwareVersion:

    FEM Top SP3 FPGA Firmware Version

- femCfgSp3FirmwareVersion:

    FEM Config SP3 FPGA Firmware Version

- femLpdClientVersion:

    LpdFemClient Software Version - Read Only

- femReadoutActive:

    FEM readout is active

- femBoardTemperature:

    FEM Board Sensor Temperature [C] Reading

- femCoreTemperature:

    FEM Core Sensor Temperature [C] Reading

- auto_mode:

    Configure default configuration when taking darks

- take_dark_frames:

    Take set of dark frames.

- startScan:

    Value with which to start scan.

- stopScan:

    Value around which to stop scan. Depends on start value and step size if it is reached exactly.

- nSteps:

    Number of steps in the intervall between start and stop.

- optWithCCMon:

    To choose delay scan with or without C&C

- delayScanSleepTime:

    Time needed for X2Timer to delay scan with C&C [s].

- delayScan:

    Start delay scan.

- runControl:

    Device controlling run management.

- self_check:

    Check if all conditions are ok for data taking.

- control:

    Control of system variables

- powerEnable:

    Allow all quadrants to receive power.

- powerDisable:

    Forbid all quadrants to receive power.

- armInterlock:

    Arm interlock to be able to power quadrants.

- disarmInterlock:

    Disarm interlock, no power allowed to quadrants.

- quad1:

    Quad1 node

- quad4:

    Quad4 node

- quad2:

    Quad2 node

- quad3:

    Quad3 node

- temperature:

    Camera temperature. Not available for all models.

- humidity:

    Humidity sensors

- leakimpedance:

    Leak sensors

- pump:

    Pump variables

- fan:

    Fan variables

- 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

- 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

- value:

    Analog input of ADC.

- semiRawValue:

    Semi raw value of analog input, i.e. the voltage.

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- relativeEpsilon:

    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- frameRate:

    Rate of processed images.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- extractedLabels:

    Out positions: labels, where the imager is extracted from the beam.

- tolerance:

    Position tolerance for increment detection

- moveOUT:

    Moves the motor to the position marked with this label

- moveC:

    Moves the motor to the position marked with this label

- moveC/:

    Moves the motor to the position marked with this label

- moveYAG:

    Moves the motor to the position marked with this label

- useAsBackgroundImage:

    Use the current image as background image.

- filterImagesByThreshold:

    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

- imageThreshold:

    The threshold for processing an image.

- absolutePositions:

    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

- subtractBkgImage:

    Subtract the loaded background image.

- subtractImagePedestal:

    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

- doMinMaxMean:

    Get the following information from the pixels: min, max, mean value.

- doBinCount:

    Calculate the frequency distribution of pixel values.

- doXYSum:

    Integrate the image along the x- and y-axes.

- doCOfM:

    Calculate centre-of-mass and widths.

- do1DFit:

    Perform a 1D gaussian fit of the x- and y-distributions.

- do2DFit:

    Perform a 2D gaussian fits.Be careful: It can be slow!

- doIntegration:

    Perform integration over region.

- clipValues:

    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

- comRange:

    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

- userDefinedRange:

    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- absThreshold:

    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

- threshold:

    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

- pixelSize:

    The pixel size. It will be used when evaluating the beam size.

- fitRange:

    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

- rangeForAuto:

    The automatic range for ‘auto’ mode (in standard deviations).

- enablePolynomial:

    Add a 1st order polynomial term (ramp) to gaussian fits.

- gauss1dStartValues:

    Selects how 1D gauss fit starting values are evaluated

- doGaussRotation:

    Allow the 2D gaussian to be rotated.

- integrationRegion:

    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- thresholdRange:

    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

- imageWidth:

    The width of the incoming image.

- imageOffsetX:

    If the incoming image has a ROI, this represents the X position of the top-left corner.

- imageBinningX:

    The image binning in the X direction.

- imageHeight:

    The height of the incoming image. Set to 1 for 1D images (spectra).

- imageOffsetY:

    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

- imageBinningY:

    The image binning in the Y direction. Set to 1 for 1D images (spectra).

- minPxValue:

    The minimum image pixel value.

- maxPxValue:

    The maximum image pixel value.

- meanPxValue:

    The mean image pixel value.

- minMaxMeanTime:

    Time spent for evaluating min, max, mean pixel value.

- binCountTime:

    Time spent for calculating the frequency distribution of pixel values.

- subtractBkgImageTime:

    Time spent in subtracting the background image.

- subtractPedestalTime:

    Time spent in subtracting the image pedestal.

- xYSumTime:

    Time spent in integrating the image in X and Y.

- cOfMTime:

    Time spent in evaluating the centre-of-mass.

- xFitTime:

    Time spent in 1D Gaussian fit of the X distribution.

- yFitTime:

    Time spent in 1D Gaussian fit of the Y distribution.

- fitTime:

    Time spent in 2D Gaussian fit of the image.

- integrationTime:

    Time spent in integrating over a region.

- x0:

    X position of the centre-of-mass.

- sx:

    Standard deviation in X of the centre-of-mass.

- y0:

    Y position of the centre-of-mass.

- sy:

    Standard deviation in Y of the centre-of-mass.

- xFitSuccess:

    1D Gaussian fit success (1-4 if fit converged).

- ax1d:

    Amplitude Ax from the 1D fit.

- x01d:

    x0 from 1D Fit.

- ex01d:

    Uncertainty on x0 estimation.

- sx1d:

    Standard deviation on x0 from 1D fit.

- esx1d:

    Uncertainty on standard deviation estimation.

- beamWidth1d:

    Beam width from 1D Fit. Defined as 4x sigma_x.

- yFitSuccess:

    1D Gaussian Fit Success (1-4 if fit converged).

- ay1d:

    Amplitude Ay from 1D fit.

- y01d:

    y0 from 1D Fit.

- ey01d:

    Uncertainty on y0 estimation.

- sy1d:

    Standard deviation on y0 from 1D fit.

- esy1d:

    Uncertainty on standard deviation estimation.

- beamHeight1d:

    Beam heigth from 1D Fit. Defined as 4x sigma_y.

- fitSuccess:

    2D Gaussian fit success (1-4 if fit converged).

- a2d:

    Amplitude from 2D fit.

- x02d:

    x0 from 2D Fit.

- ex02d:

    Uncertainty on x0 estimation.

- sx2d:

    Standard deviation on x0 from 2D fit.

- esx2d:

    Uncertainty on standard deviation estimation.

- beamWidth2d:

    Beam width from 2D Fit. Defined as 4x sigma_x.

- y02d:

    y0 from 2D Fit.

- ey02d:

    Uncertainty on y0 estimation.

- sy2d:

    Standard deviation on y0 from 2D fit.

- esy2d:

    Uncertainty on standard deviation estimation.

- beamHeight2d:

    Beam height from 2D Fit. Defined as 4x sigma_y.

- theta2d:

    Rotation angle from 2D fit.

- etheta2d:

    Uncertainty on rotation angle estimation.

- regionIntegral:

    Integral of pixel value over region specified by integrationRegion.

- regionMean:

    Mean pixel value over region specified by integrationRegion.

- moveC1:

    Moves the motor to the position marked with this label

- moveC2:

    Moves the motor to the position marked with this label

- bkg:

    The background on ADC counts.

- cal:

    The calibration constants [keV/counts].

- averagedDisplay:

    Average all the frames in the train and then display.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.

- useBackgroundFrame:

    Use Frame for Background subtraction

- frameNumber:

    The index of the frame to be used for background subtraction

- errorCount:

    Number of errors.

- 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.

- onlineDisplayEnable:

    Enable online display of detector data.

- 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

- 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)

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- roi:

    The user-defined region of interest (ROI), specified as [lowX, highX, lowY, highY]. [0, 0, 0, 0] will be interpreted as ‘whole range’.

- xIntegral:

    Integrate the image in X direction. By default integral is done over Y.

- spectrumIntegral:

    Integral of the spectrum, after applying ROI.

Release History
1.4.0-2.5.1

Created: | 2019-08-08T13:22:44.000Z
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T12:31:43.000Z
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T10:01:40.000Z
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T12:58:56.000Z
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T08:34:30.000Z
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T13:50:05.000Z
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T10:28:08.000Z
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T16:29:31.000Z
Author: | Andrea Parenti
Notes: |

###### GOTTHARD_DETECTOR-1

Instance id: | FXE_OGT1_TAD/CAL/GOTTHARD_DETECTOR-1
Class id: | SlsCalibrator
Host: | fxe-rr-sys-con-2
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsCalibrator
Last modified: | 2020-11-24T12:09:30.000+01:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Parenti, Hauf, Danilevski
Latest tag: | 1.4.1-2.10.0
Deployment tag: | 1.4.1-2.10.0
Scenes: | FXE_OGT1_TAD_GOTTHARD, FXE_OGT1_TAD_GOTTHARD_2D, FXE_OGT1_TAD_GOTTHARD_water_fall
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!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- bkg:
    The background on ADC counts.
- cal:
    The calibration constants [keV/counts].
- averagedDisplay:
    Average all the frames in the train and then display.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.
- useBackgroundFrame:
    Use Frame for Background subtraction
- frameNumber:
    The index of the frame to be used for background subtraction
- errorCount:
    Number of errors.
- reset:
    Reset error count.

Release History
1.4.1-2.10.0

Created: | 2020-11-24T11:14:02.000Z
Author: | Andrea Parenti
Notes: | Summary: added version info

1.4.0-2.5.1

Created: | 2019-08-08T13:22:44.000Z
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T12:31:43.000Z
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T10:01:40.000Z
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T12:58:56.000Z
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T08:34:30.000Z
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T13:50:05.000Z
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T10:28:08.000Z
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T16:29:31.000Z
Author: | Andrea Parenti
Notes: |

##### CAM

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DET

###### CONTROL-1

Instance id: | FXE_OGT1_TAD/DET/CONTROL-1
Host: | exflcon06n0
Class documentation:
| GotthardControl
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-04-30T14:33:02.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti
Latest tag: | 1.7.2-2.8.3
Deployment tag: | 1.7.2-2.8.3
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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_:

    Do not set this property, it will be set by the device-server

- 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.

- _serverId_:

    Do not set this property, it will be set by the device-server

- 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 defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

    Do not set this property, it will be set by the device-server.

- pid:

    The unix 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:

    Calibrate actual position to calibrated position.

- availableScenes:

    Scenes from the Slit System

- _connection_:

    Do not set this property, it will be set by the device-server

- useTimeserver:

    Unused - whether device connects to time server is configured via ‘timeServerId’

- progress:

    The progress of the current action

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

    InstanceId of the BeckhoffCom device that forwards commands to the PLC.

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

    This word encodes in bits the hardware-status information of this device

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

- epsilon:

    The epsilon determines the amount of change until a new physical value is posted from the hardware

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

    Defines whether interlock is ok (true) or broken (false).

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

- maxStateUpdateRate:

    If state updates per second exceed this threshold, the state will be displayed as CHANGING

- noisyStateUpdateRateValue:

    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

- isStateUpdateNoisy:

    State update rate is above ‘Max State Update Rate’ threshold.

- reset:

    Resets the device in case of an error

- enableInterlockedSlots:

    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

- disableInterlockedSlots:

    Send device into INTERLOCKED state, thus enabling all interlocked slots.

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

- readHardware:

    Requests value updates from the PLC for the properties listed under ‘Properties to read’

- force:

    ???

- trigger:

    Sends a software trigger to the camera

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- interfaces:

    Describes the interfaces of this device

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    CMoveAbsolute

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- 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

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    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.

- topChannel:

    Please specify the ADC channel which correspond to Top

- bottomChannel:

    Please specify the ADC channel which correspond to Bottom

- leftChannel:

    Please specify the channel which correspond to Left

- rightChannel:

    Please specify the channel which correspond to Right

- calibrationFactorX:

    Calibration Factor to align beam position in x direction

- calibrationFactorY:

    Calibration Factor to align beam position in y direction

- upperBound:

    upper range of window to select desired pulses

- lowerBound:

    Lower range of window to select desired pulses

- temporalAverage:

    Average is evaluated over N last Trains

- numberOfPulses:

    Number of pulses per train

- pulseThreshold:

    Threshold to validate the pulse

- trainThreshold:

    Threshold to validate the train

- pulseValidity:

    True, if a value of all channels at a given pulses are greater than pulse threshold otherwise false

- trainValidity:

    True, if pulseValidity of all channels are greater than train threshold otherwise false

- quadrant:

    Quadrant

- scatterPosition:

    Scatter Position Node

- reconnectInterval:

    Reconnect Interval to DOOCS in case of ERROR

- location:

    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION

- updateInterval:

    Update interval.

- lockStatus:

    O: Locked - 1: NOT locked - 3: Unknown

- lock:

    lock

- unlock:

    Unlock the laser by setting the coarseTune to ID: 7

- 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

- stepLength:

    Step length used in Step Up/Step Down.

- zeroAngle:

    The position of the motor where the zero angle is defined

- offsetIntensity:

    Defines the lowest soft limit

- 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

- timeoutConnectToBCom:

    Timeout for succesfully connect to PLC

- timeoutReadDevConfig:

    Timeout for getting the same number of failures when reading the configuration of devices

- setDefaultDevConfig:

    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device

- outputFileRoot:

    Template string for output XML file

- inputFileTemplate:

    File with variables to save in FW

- configDir:

    Folder to store configuration files

- plcInFwTemplate:

    List of PLCs which have a specific configuration to save, as found in the FW Template

- instantiateDevices:

    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.

- instantiateQuick:

    Instantiate all devices on selected PLC quickly

- instantiateGroupDevices:

    Instantiate all selected group devices in selected PLC

- instantiateComponentDevices:

    Instantiate all selected component devices in selectedPLC

- resetDevices:

    Reset all devices in Error state

- getOfflineDevices:

    Check which devices are still offline

- shutdownDevices:

    Shutdown all devices

- shutdownGroupDevices:

    Shutdown all group devices

- shutdownComponentDevices:

    Shutdown all component devices

- getPLCsInFwTemplate:

    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.

- getPLCsInSystem:

    Get list of PLCs active in current topic

- handleMultiConfigToXML:

    The retrieved config of devices in PLCs is written on an XML file

- handleSingleConfigToXML:

    The retrieved config of devices in selected beckhoffId is written in XML file

- serverUri:

    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.

- serverTimeout:

    Timeout for server responses.

- autoResetTime:

    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.

- connectionSettlingTime:

    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- plcUptime:

    Total time (in seconds), that the PLC server is up and running

- createGenericDevices:

    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.

- messageRateOut:

    The average rate of messages sent by BeckhoffCom

- messageRateIn:

    The average rate of messages received by BeckhoffCom

- byteRateOut:

    The average rate of bytes sent by BeckhoffCom

- byteRateIn:

    The average rate of bytes received by BeckhoffCom

- availablePlcDevices:

    Lists all available PLC devices

- updatesRate:

    The average rate of updates to the Beckhoff Devices

- devicesBlacklist:

    List of the devices that will not be instantiated automatically.

- instantiationInterval:

    The interval between consecutive instantiations

- ACpuFrequency:

    Frequency of the CPU.

- ACurrentCpuUsage:

    Current CPU usage.

- ACurrentCpuTemperature:

    Current temperature of the CPU.

- AProgramMemoryAllocated:

    Allocated program memory.

- AProgramMemoryAvailable:

    Available program memory.

- AStorageMemoryAllocated:

    Allocated storage-memory. Available on Windows CE.

- AStorageMemoryAvailable:

    Available storage-memory. Available on Windows CE.

- AMemoryDivision:

    MemoryDivision. Available on Windows CE.

- AProgramMemoryAllocated2:

    Allocated program memory.

- AProgramMemoryAvailable2:

    Available program memory.

- AMacAddess:

    MAC-Address of the PLC (17 char string).

- AIpv4Address:

    Current IPv4 Address of the PLC in dotted notation (15 char string).

- AIpv4SubnetMask:

    IPv4 subnet mask of the PLC in dotted notation (15 char string).

- ADhcpServerIpv4Address:

    IP-Address of the DHCP-Server in dotted notation (15 char string).

- ADhcpServerEnabled:

    True if the DHCP-Server is enabled.

- AMainboardType:

    Type of the main-board.

- ASerialNumber:

    Serial number.

- AProductionDate:

    Production date of the main-board.

- ABootCount:

    Boot count.

- AOperatingTimeInMinutes:

    Operating time of the main-board.

- AMinBoardTemperature:

    Minimum temperature of the main-board.

- AMaxBoardTemperature:

    Maximum temperature of the main-board.

- MinInputVoltage:

    Minimum input voltage of the main-board.

- MaxInputVoltage:

    Maximum input voltage of the main-board.

- MainboardTemperature:

    Current temperature of the main-board.

- APlcProjectVersion:

    PLC Project Version

- AProjectGeneratorVersion:

    Project Generator Version

- ATCPBufferSize:

    TCP/IP buffer size.

- ATrainID:

    Train ID

- ABeamModes:

    Beam Modes

- ATCPOutputDataRate:

    TCP Output Data Rate

- ATCPOutputBufLvlMax:

    TCP Output Buf Lvl Max

- ATCPInputDataRate:

    TCP Input Data Rate

- ATCPInputBufLvlMax:

    TCP Input Buf Lvl Max

- APLCCycleTime:

    PLC Cycle Time

- ignore:

    Ignore

- configure:

    Upload configuration parameters to the FEM

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- lastStatusMessage:

    Status message of last command

- loggerConfig:

    Runtime logger configuration

- policy:

    Errors handling policy

- ApplicationMonitor:

    Application health monitor

- BookKeeper:

    Book keeper

- BufferManager:

    Buffer manager

- DataAccessor0:

    Data accessor 0

- DataAccessor1:

    Data accessor 1

- DataDispatcher:

    Data dispatcher

- DataIntegrator:

    Data integrator

- DataMonitor:

    Data content monitor

- FastDataCollector:

    Fast data collector

- Formatter:

    Formatter

- InternalTrigger:

    Internal trigger

- MessageLogger:

    Message logger

- PreProcessor:

    Pre processor

- Scheduler:

    Scheduler

- SlowDataCollector:

    Slow data collector

- StatisticsBuilder:

    Statistics builder

- Summarizer:

    Data summarizer

- TrainDataReceiver:

    Train data receiver

- TrainReconstructor:

    Train data reconstructor

- Vectorizer:

    Data vectorizer

- Writer:

    Writer

- enableDaqNode:

    Enable DAQ node

- storageManager:

    Storage manager device

- groupId:

    Aggregators group Id

- groupInfix:

    Aggregators group infix

- channelId:

    channel Id

- channelsCount:

    Number of channels

- mountPoint:

    Mount point

- dataPath:

    Proposal data path

- chunkSize:

    Number of trains to buffer in memory

- chunksCount:

    Chunk count per file

- maxExpectedPulses:

    Maximum number of pulses expected per train

- dataType:

    Data type

- runController:

    The deviceId of the RunController to use, starts and stops daq.

- experimentDetails:

    Experiment details

- sampleDetails:

    Sample details

- runDetails:

    Run details

- enableXTDF:

    Enable receiving train data via UDP

- OriginalDataFormat:

    Name of file that contains the original data format description, include train data format, dataset and run info.

- Detector:

    Name of file that contains the detector configuration.

- timeServerId:

    The instance id uniquely identifies a TimeServer instance in the distributed system

- Logger:

    Logging settings

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- 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

- group:

    Structure describing data sources logically belonging together.

- owner:

    The person to contact regarding usage of this group

- 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

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- createGrid:

    Create a parallelogram with the following input

    > steps_x, steps_y, v_bl=None, v_br=None, v_tl=None, v_tr=None, exclude=”topRight”

- 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

- 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:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- 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’.

- availableMacros:

    Provides scan macros from the scan device

- output:

    Output Channel for the scan data

- abort:

    Call this slot to stop everything

- pause:

    Call this slot to pause or resume running scan

- proxy:

    The Clock and Control device

- uploadOk:

    Was the upload to Veto Memory Successful

- displayedSequence:

    Sequence generated from user input

- displayedBinOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered

- displayedOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered, human readable

- vetoMode:

    The mode in which to generate the pattern.

- inputString:

    The input can be valid python code, that generates either an integer, or an iterable of integers. When doing equations, remember to cast your floats to ints.

- saveVetoPatternFile:

    Save VETO pattern to disk file, as configured in the CCMon device

- uploadPatternFile:

    Upload VETO pattern from file into VETO memory, as configured in the CCMon device, and check that the upload was correct

- deviceNames:

    The LpdFem devices to be sub-control

- connectFem:

    Open connection to FEM

- disconnectFem:

    Close connection to FEM

- prepare:

    Prepare new configuration parameters for the FEM

- startDAQ:

    Start data acquisition

- stopDAQ:

    Stop acquisition immediately

- sync_params:

    Sets all composite parameters on fems.

- manual_recover:

    Try recovery from UNKNOWN after state desynchronization has been manually solved for the respective children.

- asicPowerEnable0:

    ASIC 0 LV Power Enable

- asicPowerEnable1:

    ASIC 1 LV Power Enable

- asicRxGainAlgorithmType:

    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)

- asicRxGainThresholdx10:

    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- asicRxGainThresholdx100:

    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- cccEmulationMode:

    Enable to emulate Clock & Control commands (for testing in absence of C&C)

- cccProvideNumberImages:

    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages

- cccResetDelay:

    Adjust timing of reset (in steps of clock cycles)

- cccStopDelay:

    Adjust timing of the stop (in steps of clock cycles)

- cccSystemMode:

    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes

- cccVetoPatternFile:

    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)

- cccVetoStartDelay:

    Adjust timing of veto arrival (in steps of clock cycles)

- femAsicClockSource:

    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond

- femAsicCmdSequence:

    ASIC Command Words defined in XML syntax

- femAsicCommandLength:

    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz

- femAsicDataType:

    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom

- femAsicGain:

    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)

- femAsicPixelFeedbackOverride:

    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides

- femAsicPixelSelfTestOverride:

    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides

- femAsicSetupParams:

    ASIC Setup Parameters defined in XML syntax

- femInvertAdcData:

    Enable Invert ADC ASIC data True=Invert Data

- femPpcEmulatePipeline:

    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors

- femPpcImageReordering:

    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled

- femPpcMode:

    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout

- femStartTrainDelay:

    Delay between trigger arrival and start of train (in FEM clock cycles)

- femStartTrainInhibit:

    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout

- femStartTrainPolarity:

    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal

- femStartTrainSource:

    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond

- femVetoPolarity:

    Set polarity of the external veto signal 0=No inversion, 1=Invert signal

- integrationCycles:

    Sets the number of integration cycles per images

- numPulsesInTrainOverride:

    Length of XRay Pulse Train (number pulses)

- numberImages:

    Sets the number of images per trigger

- numberTrains:

    Number of trains [if LL Data Generator or PPC Data Direct selected]

- sensorBias0:

    Sensor 0 HV Bias Voltage [V]

- sensorBias1:

    Sensor 1 HV Bias Voltage [V]

- sensorBiasEnable0:

    Sensor 0 HV Bias Enable

- sensorBiasEnable1:

    Sensor 1 HV Bias Enable

- tenGigInterframeGap:

    10GigE Inter-frame gap timer [clock cycles]

- tenGigUdpPacketLen:

    10GigE UDP packet payload length

- timeoutTrain:

    Timeout in seconds on waiting for next Train during run

- trainGenInterval:

    Interval (in 100 mhz clock periods) between internally generated Train start commands

- proxyCACML:

    The Clock and Control device

- fem:

    Device controlling Fem, can be composite

- ccMon:

    Device controlling clock & control.

- data_taking:

    Detector Device That Implements TakeData Function.

- x2Timer:

    The utca device

- cancel:

    Cancels last button pressed.

- femBootUpTime:

    Time needed for FEM to be responsive after powering up [s].

- asicBootUpTime:

    Time needed for asics to follow last commands [s].

- powerTimeout:

    Time needed for power to arrive at all FEMS [s].

- configTimeout:

    Time needed for femComposit to upload config

- scenarioConfig:

    Configuration of common operation scenarios

- emergencyShutdown:

    Power off quadrants immediately.

- uploadConfig:

    Sends selected configuration to detector.

- getReady:

    Bring detector in a state ready for data taking

- startDisablePower:

    Disable LPDpower & …

- disable:

    Disable FEM to be ignored

- enable:

    Enable FEM to be part of the system

- disabled:

    Disable FEM, will no longer be controlled by the composite

- sys_status:

    Status summary

- error_msg:

    Error message.

- sync_start_time:

    Unix timestamp to trigger start at

- femHost:

    FEM hostname or IP address

- femPort:

    FEM port number

- femTimeout:

    FEM connection timeout

- femAsicModuleType:

    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone

- femLegacyPowerCard:

    Enable legacy power card support

- tenGig0SourceMac:

    10GigE 0 UDP Source MAC Address

- tenGig0SourceIp:

    10GigE 0 UDP Source IP Address

- tenGig0SourcePort:

    10GigE 0 UDP Source Port

- tenGig0DestMac:

    10GigE 0 UDP Destination MAC Address

- tenGig0DestIp:

    10GigE 0 UDP Destination IP Address

- tenGig0DestPort:

    10GigE 0 UDP Destination Port

- femEnableTenGig:

    Enables transmission of image data via 10GigE UDP interface

- femDataSource:

    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)

- femAsicEnableMask:

    ASIC RX channel enable mask (4*32 bits)

- femReadoutOperatingMode:

    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD

- femAsicLocalClock:

    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)

- femAsicSetupLoadMode:

    ASIC control load mode 0=parallel, 1=daisy chain (being tested)

- femAsicRxCmdWordStart:

    Enable ASIC readout started by Command Word in femAsicCmdSequence file

- femAsicSetupClockPhase:

    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset

- tenGigFarmMode:

    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists

- femAsicVersion:

    ASIC Version 1=version 1, 2=version 2

- femAsicGainOverride:

    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)

- femDebugLevel:

    Set the debug level

- tenGig0DataGenerator:

    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0DataFormat:

    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0FrameLength:

    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0NumberOfFrames:

    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]

- femModuleId:

    ID for FEM to differentiate from which FEM data is coming from 0 - 15

- femAsicTestDataPatternType:

    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image

- femTrainIdInitLsw:

    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker

- femTrainIdInitMsw:

    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker

- powerCardFault0:

    Power Card 0 Fault Flag

- powerCardFault1:

    Power Card 1 Fault Flag

- powerCardFemStatus0:

    Power Card 0 FEM Status Flag

- powerCardFemStatus1:

    Power Card 1 FEM Status Flag

- powerCardExtStatus0:

    Power Card 0 External Status Flag

- powerCardExtStatus1:

    Power Card 1 External Status Flag

- powerCardOverCurrent0:

    Power Card 0 Overcurrent Flag

- powerCardOverCurrent1:

    Power Card 1 Overcurrent Flag

- powerCardOverTemp0:

    Power Card Over 0 Temperature Flag

- powerCardOverTemp1:

    Power Card Over 1 Temperature Flag

- powerCardUnderTemp0:

    Power Card Under 0 Temperature Flag

- powerCardUnderTemp1:

    Power Card Under 1 Temperature Flag

- powerCardTemp0:

    Power Card 0 Temperature [C]

- powerCardTemp1:

    Power Card 1 Temperature [C]

- sensor0Temp:

    Sensor 0 Temperature [C]

- sensor1Temp:

    Sensor 1 Temperature [C]

- sensor2Temp:

    Sensor 2 Temperature [C]

- sensor3Temp:

    Sensor 3 Temperature [C]

- sensor4Temp:

    Sensor 4 Temperature [C]

- sensor5Temp:

    Sensor 5 Temperature [C]

- sensor6Temp:

    Sensor 6 Temperature [C]

- sensor7Temp:

    Sensor 7 Temperature [C]

- sensor8Temp:

    Sensor 8 Temperature [C]

- sensor9Temp:

    Sensor 9 Temperature [C]

- sensor10Temp:

    Sensor 10 Temperature [C]

- sensor11Temp:

    Sensor 11 Temperature [C]

- sensor12Temp:

    Sensor 12 Temperature [C]

- sensor13Temp:

    Sensor 13 Temperature [C]

- sensor14Temp:

    Sensor 14 Temperature [C]

- sensor15Temp:

    Sensor 15 Temperature [C]

- femVoltage0:

    FEM 5V Supply 0 Voltage [V]

- femVoltage1:

    FEM 5V Supply 1 Voltage [V]

- femCurrent0:

    FEM 5V Supply 0 Current [A]

- femCurrent1:

    FEM 5V Supply 1 Current [A]

- digitalVoltage0:

    ASIC 1.2V Digital Supply 0 Voltage [V]

- digitalVoltage1:

    ASIC 1.2V Digital Supply 1 Voltage [V]

- digitalCurrent0:

    ASIC 1.2V Digital Supply 0 Current [mA]

- digitalCurrent1:

    ASIC 1.2V Digital Supply 1 Current [mA]

- sensor0Voltage:

    Sensor 0 3.3V Supply Voltage [V]

- sensor1Voltage:

    Sensor 1 3.3V Supply Voltage [V]

- sensor2Voltage:

    Sensor 2 3.3V Supply Voltage [V]

- sensor3Voltage:

    Sensor 3 3.3V Supply Voltage [V]

- sensor4Voltage:

    Sensor 4 3.3V Supply Voltage [V]

- sensor5Voltage:

    Sensor 5 3.3V Supply Voltage [V]

- sensor6Voltage:

    Sensor 6 3.3V Supply Voltage [V]

- sensor7Voltage:

    Sensor 7 3.3V Supply Voltage [V]

- sensor8Voltage:

    Sensor 8 3.3V Supply Voltage [V]

- sensor9Voltage:

    Sensor 9 3.3V Supply Voltage [V]

- sensor10Voltage:

    Sensor 10 3.3V Supply Voltage [V]

- sensor11Voltage:

    Sensor 11 3.3V Supply Voltage [V]

- sensor12Voltage:

    Sensor 12 3.3V Supply Voltage [V]

- sensor13Voltage:

    Sensor 13 3.3V Supply Voltage [V]

- sensor14Voltage:

    Sensor 14 3.3V Supply Voltage [V]

- sensor15Voltage:

    Sensor 15 3.3V Supply Voltage [V]

- sensor0Current:

    Sensor 0 3.3V Supply Current [A]

- sensor1Current:

    Sensor 1 3.3V Supply Current [A]

- sensor2Current:

    Sensor 2 3.3V Supply Current [A]

- sensor3Current:

    Sensor 3 3.3V Supply Current [A]

- sensor4Current:

    Sensor 4 3.3V Supply Current [A]

- sensor5Current:

    Sensor 5 3.3V Supply Current [A]

- sensor6Current:

    Sensor 6 3.3V Supply Current [A]

- sensor7Current:

    Sensor 7 3.3V Supply Current [A]

- sensor8Current:

    Sensor 8 3.3V Supply Current [A]

- sensor9Current:

    Sensor 9 3.3V Supply Current [A]

- sensor10Current:

    Sensor 10 3.3V Supply Current [A]

- sensor11Current:

    Sensor 11 3.3V Supply Current [A]

- sensor12Current:

    Sensor 12 3.3V Supply Current [A]

- sensor13Current:

    Sensor 13 3.3V Supply Current [A]

- sensor14Current:

    Sensor 14 3.3V Supply Current [A]

- sensor15Current:

    Sensor 15 3.3V Supply Current [A]

- sensorBiasVoltage0:

    Sensor bias 0 voltage readback [V]

- sensorBiasVoltage1:

    Sensor bias 1 voltage readback [V]

- sensorBiasCurrent0:

    Sensor bias 0 current readback [uA]

- sensorBiasCurrent1:

    Sensor bias 1 current readback [uA]

- femV5FirmwareVersion:

    FEM V5 Firmware Version

- femBotSp3FirmwareVersion:

    FEM Bottom SP3 FPGA Firmware Version

- femTopSp3FirmwareVersion:

    FEM Top SP3 FPGA Firmware Version

- femCfgSp3FirmwareVersion:

    FEM Config SP3 FPGA Firmware Version

- femLpdClientVersion:

    LpdFemClient Software Version - Read Only

- femReadoutActive:

    FEM readout is active

- femBoardTemperature:

    FEM Board Sensor Temperature [C] Reading

- femCoreTemperature:

    FEM Core Sensor Temperature [C] Reading

- auto_mode:

    Configure default configuration when taking darks

- take_dark_frames:

    Take set of dark frames.

- startScan:

    Value with which to start scan.

- stopScan:

    Value around which to stop scan. Depends on start value and step size if it is reached exactly.

- nSteps:

    Number of steps in the intervall between start and stop.

- optWithCCMon:

    To choose delay scan with or without C&C

- delayScanSleepTime:

    Time needed for X2Timer to delay scan with C&C [s].

- delayScan:

    Start delay scan.

- runControl:

    Device controlling run management.

- self_check:

    Check if all conditions are ok for data taking.

- control:

    Control of system variables

- powerEnable:

    Allow all quadrants to receive power.

- powerDisable:

    Forbid all quadrants to receive power.

- armInterlock:

    Arm interlock to be able to power quadrants.

- disarmInterlock:

    Disarm interlock, no power allowed to quadrants.

- quad1:

    Quad1 node

- quad4:

    Quad4 node

- quad2:

    Quad2 node

- quad3:

    Quad3 node

- temperature:

    Camera temperature. Not available for all models.

- humidity:

    Humidity sensors

- leakimpedance:

    Leak sensors

- pump:

    Pump variables

- fan:

    Fan variables

- 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

- 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

- value:

    Analog input of ADC.

- semiRawValue:

    Semi raw value of analog input, i.e. the voltage.

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- relativeEpsilon:

    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- 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:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- extractedLabels:

    Out positions: labels, where the imager is extracted from the beam.

- tolerance:

    Position tolerance for increment detection

- moveOUT:

    Moves the motor to the position marked with this label

- moveC:

    Moves the motor to the position marked with this label

- moveC/:

    Moves the motor to the position marked with this label

- moveYAG:

    Moves the motor to the position marked with this label

- useAsBackgroundImage:

    Use the current image as background image.

- filterImagesByThreshold:

    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

- imageThreshold:

    The threshold for processing an image.

- absolutePositions:

    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

- subtractBkgImage:

    Subtract the loaded background image.

- subtractImagePedestal:

    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

- doMinMaxMean:

    Get the following information from the pixels: min, max, mean value.

- doBinCount:

    Calculate the frequency distribution of pixel values.

- doXYSum:

    Integrate the image along the x- and y-axes.

- doCOfM:

    Calculate centre-of-mass and widths.

- do1DFit:

    Perform a 1D gaussian fit of the x- and y-distributions.

- do2DFit:

    Perform a 2D gaussian fits.Be careful: It can be slow!

- doIntegration:

    Perform integration over region.

- clipValues:

    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

- comRange:

    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

- userDefinedRange:

    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- absThreshold:

    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

- threshold:

    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

- pixelSize:

    The pixel size. It will be used when evaluating the beam size.

- fitRange:

    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

- rangeForAuto:

    The automatic range for ‘auto’ mode (in standard deviations).

- enablePolynomial:

    Add a 1st order polynomial term (ramp) to gaussian fits.

- gauss1dStartValues:

    Selects how 1D gauss fit starting values are evaluated

- doGaussRotation:

    Allow the 2D gaussian to be rotated.

- integrationRegion:

    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- thresholdRange:

    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

- imageWidth:

    The width of the incoming image.

- imageOffsetX:

    If the incoming image has a ROI, this represents the X position of the top-left corner.

- imageBinningX:

    The image binning in the X direction.

- imageHeight:

    The height of the incoming image. Set to 1 for 1D images (spectra).

- imageOffsetY:

    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

- imageBinningY:

    The image binning in the Y direction. Set to 1 for 1D images (spectra).

- minPxValue:

    The minimum image pixel value.

- maxPxValue:

    The maximum image pixel value.

- meanPxValue:

    The mean image pixel value.

- minMaxMeanTime:

    Time spent for evaluating min, max, mean pixel value.

- binCountTime:

    Time spent for calculating the frequency distribution of pixel values.

- subtractBkgImageTime:

    Time spent in subtracting the background image.

- subtractPedestalTime:

    Time spent in subtracting the image pedestal.

- xYSumTime:

    Time spent in integrating the image in X and Y.

- cOfMTime:

    Time spent in evaluating the centre-of-mass.

- xFitTime:

    Time spent in 1D Gaussian fit of the X distribution.

- yFitTime:

    Time spent in 1D Gaussian fit of the Y distribution.

- fitTime:

    Time spent in 2D Gaussian fit of the image.

- integrationTime:

    Time spent in integrating over a region.

- x0:

    X position of the centre-of-mass.

- sx:

    Standard deviation in X of the centre-of-mass.

- y0:

    Y position of the centre-of-mass.

- sy:

    Standard deviation in Y of the centre-of-mass.

- xFitSuccess:

    1D Gaussian fit success (1-4 if fit converged).

- ax1d:

    Amplitude Ax from the 1D fit.

- x01d:

    x0 from 1D Fit.

- ex01d:

    Uncertainty on x0 estimation.

- sx1d:

    Standard deviation on x0 from 1D fit.

- esx1d:

    Uncertainty on standard deviation estimation.

- beamWidth1d:

    Beam width from 1D Fit. Defined as 4x sigma_x.

- yFitSuccess:

    1D Gaussian Fit Success (1-4 if fit converged).

- ay1d:

    Amplitude Ay from 1D fit.

- y01d:

    y0 from 1D Fit.

- ey01d:

    Uncertainty on y0 estimation.

- sy1d:

    Standard deviation on y0 from 1D fit.

- esy1d:

    Uncertainty on standard deviation estimation.

- beamHeight1d:

    Beam heigth from 1D Fit. Defined as 4x sigma_y.

- fitSuccess:

    2D Gaussian fit success (1-4 if fit converged).

- a2d:

    Amplitude from 2D fit.

- x02d:

    x0 from 2D Fit.

- ex02d:

    Uncertainty on x0 estimation.

- sx2d:

    Standard deviation on x0 from 2D fit.

- esx2d:

    Uncertainty on standard deviation estimation.

- beamWidth2d:

    Beam width from 2D Fit. Defined as 4x sigma_x.

- y02d:

    y0 from 2D Fit.

- ey02d:

    Uncertainty on y0 estimation.

- sy2d:

    Standard deviation on y0 from 2D fit.

- esy2d:

    Uncertainty on standard deviation estimation.

- beamHeight2d:

    Beam height from 2D Fit. Defined as 4x sigma_y.

- theta2d:

    Rotation angle from 2D fit.

- etheta2d:

    Uncertainty on rotation angle estimation.

- regionIntegral:

    Integral of pixel value over region specified by integrationRegion.

- regionMean:

    Mean pixel value over region specified by integrationRegion.

- moveC1:

    Moves the motor to the position marked with this label

- moveC2:

    Moves the motor to the position marked with this label

- bkg:

    The background on ADC counts.

- cal:

    The calibration constants [keV/counts].

- averagedDisplay:

    Average all the frames in the train and then display.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.

- useBackgroundFrame:

    Use Frame for Background subtraction

- frameNumber:

    The index of the frame to be used for background subtraction

- errorCount:

    Number of errors.

- 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.

- onlineDisplayEnable:

    Enable online display of detector data.

- 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

- 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)

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- roi:

    The user-defined region of interest (ROI), specified as [lowX, highX, lowY, highY]. [0, 0, 0, 0] will be interpreted as ‘whole range’.

- xIntegral:

    Integrate the image in X direction. By default integral is done over Y.

- spectrumIntegral:

    Integral of the spectrum, after applying ROI.

Release History
1.7.2-2.8.3

Created: | 2020-04-30T12:40:13.000Z
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T05:03:42.000Z
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T09:29:59.000Z
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

###### GOTTHARD_DETECTOR-1

Instance id: | FXE_OGT1_TAD/DET/GOTTHARD_DETECTOR-1
Class id: | GotthardControl
Host: | fxe-rr-sys-con-2
Class documentation:
| GotthardControl
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2021-06-08T10:33:28.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Flucke
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_OGT1_TAD_GOTTHARD, FXE_OGT1_TAD_GOTTHARD_water_fall
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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Starts acquisition
- stop:
    Stops acquisition
- reset:
    Resets the device in case of an error
- detectorHostName:
    Detector Host Name
- detectorIp:
    Detector IP. Must be on the same subnet as the receiver.
- detectorHostPort:
    Detector Host Port. Will use 1952 if left empty.
- detectorHostStopPort:
    Detector Host Stop Port. Will use 1953 if left empty.
- rxHostname:
    Receiver Hostname
- rxTcpPort:
    Receiver TCP Port
- rxUdpIp:
    Receiver UDP IP
- rxUdpPort:
    Receiver UDP Port
- settings:
    Settings
- online:
    Sets the detector in online (1) or offline (0) mode.
- angDir:
    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).
- moveFlag:
    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)
- lock:
    lock
- extSig0:
    Ext Sig 0
- vHighVoltageMax:
    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.
- vHighVoltage:
    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200
- master:
    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.
- sync:
    Sets the synchronization mode of the various controller within a detector structure
- badChannels:
    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.
- angConv:
    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.
- globalOff:
    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.
- binSize:
    Sets the size of the angular bins for angular conversion.
- threaded:
    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
- detectorDeveloper:
    Detector Developer. (useful to define subset of working functions)
- flatFieldCorrectionFile:
    Flat field corrections file name. Use ‘none’ to disable corrections.
- positions:
    Positions for the acquisition. Usage: n pos1 pos2 … posn
- maximumDetectorSize:
    Maximum detector size
- bitDepth:
    Bit Depth
- exposureTime:
    exposure time value
- exposurePeriod:
    exposure period
- delayAfterTrigger:
    delay after trigger
- numberOfGates:
    Number Of Gates
- numberOfFrames:
    Number Of Frames
- numberOfCycles:
    Number Of Cycles
- timing:
    The timing mode of the detector
- acquisitionTime:
    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.
- triggerPeriod:
    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.
- detectorNumber:
    Returns the serial number of the module (normally the MAC address).
- detectorVersion:
    Returns the version of the controller firmware.
- softwareVersion:
    Returns the version of the software running on the detector.
- thisVersion:
    Returns the version of the control software which is being used.
- pollingInterval:
    The interval for polling the laser front-end for status.
- tempAdc:
    Returns the ADC temperature.
- tempFpga:
    Returns the FPGA temperature.
- detectorMac:
    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.
- rOnline:
    rOnline

Release History
1.9.2-2.11.1

Created: | 2021-05-18T15:36:27.000Z
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T09:19:30.000Z
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T14:38:14.000Z
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T10:18:30.000Z
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T08:58:03.000Z
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T10:31:41.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

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

###### GOTTHARD_RECEIVER-1

Instance id: | FXE_OGT1_TAD/DET/GOTTHARD_RECEIVER-1
Class id: | GotthardReceiver
Host: | fxe-rr-sys-con-2
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2021-06-08T10:33:28.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Flucke
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_OGT1_TAD_GOTTHARD, FXE_OGT1_TAD_GOTTHARD_water_fall
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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T15:36:27.000Z
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T09:19:30.000Z
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T14:38:14.000Z
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T10:18:30.000Z
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T08:58:03.000Z
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T10:31:41.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

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

###### RECEIVER-2

Instance id: | FXE_OGT1_TAD/DET/RECEIVER-2
Host: | exflcon06n0
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-04-30T14:33:02.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti
Latest tag: | 1.7.2-2.8.3
Deployment tag: | 1.7.2-2.8.3
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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_:

    Do not set this property, it will be set by the device-server

- 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.

- _serverId_:

    Do not set this property, it will be set by the device-server

- 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 defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

    Do not set this property, it will be set by the device-server.

- pid:

    The unix 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:

    Calibrate actual position to calibrated position.

- availableScenes:

    Scenes from the Slit System

- _connection_:

    Do not set this property, it will be set by the device-server

- useTimeserver:

    Unused - whether device connects to time server is configured via ‘timeServerId’

- progress:

    The progress of the current action

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

    InstanceId of the BeckhoffCom device that forwards commands to the PLC.

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

    This word encodes in bits the hardware-status information of this device

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.

- epsilon:

    The epsilon determines the amount of change until a new physical value is posted from the hardware

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

    Defines whether interlock is ok (true) or broken (false).

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate

- maxStateUpdateRate:

    If state updates per second exceed this threshold, the state will be displayed as CHANGING

- noisyStateUpdateRateValue:

    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.

- isStateUpdateNoisy:

    State update rate is above ‘Max State Update Rate’ threshold.

- reset:

    Resets the device in case of an error

- enableInterlockedSlots:

    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.

- disableInterlockedSlots:

    Send device into INTERLOCKED state, thus enabling all interlocked slots.

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed

- readHardware:

    Requests value updates from the PLC for the properties listed under ‘Properties to read’

- force:

    ???

- trigger:

    Sends a software trigger to the camera

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- interfaces:

    Describes the interfaces of this device

- home:

    CHoming

- on:

    CEnableAxis

- off:

    CDisableAxis

- calibrateToEncoder:

    Calibrate actual position to encoder position.

- calibrateTarget:

    The motor scale is set to this position when hitting calibrate

- resetAxis:

    CResetAxis

- specificError:

    ASpecificError

- moveRelative:

    CMoveRelative

- move:

    CMoveAbsolute

- emergencyStop:

    CStop

- stop:

    Stops acquisition

- moveConstantVelocity:

    set property amovevelocity

- moveModulo:

- 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

- mc2ErrorStop:

- isOnTarget:

    Indicates whether the motor is on target or not.

- relativeDeadband:

    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

- stepUp:

    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.

- topChannel:

    Please specify the ADC channel which correspond to Top

- bottomChannel:

    Please specify the ADC channel which correspond to Bottom

- leftChannel:

    Please specify the channel which correspond to Left

- rightChannel:

    Please specify the channel which correspond to Right

- calibrationFactorX:

    Calibration Factor to align beam position in x direction

- calibrationFactorY:

    Calibration Factor to align beam position in y direction

- upperBound:

    upper range of window to select desired pulses

- lowerBound:

    Lower range of window to select desired pulses

- temporalAverage:

    Average is evaluated over N last Trains

- numberOfPulses:

    Number of pulses per train

- pulseThreshold:

    Threshold to validate the pulse

- trainThreshold:

    Threshold to validate the train

- pulseValidity:

    True, if a value of all channels at a given pulses are greater than pulse threshold otherwise false

- trainValidity:

    True, if pulseValidity of all channels are greater than train threshold otherwise false

- quadrant:

    Quadrant

- scatterPosition:

    Scatter Position Node

- reconnectInterval:

    Reconnect Interval to DOOCS in case of ERROR

- location:

    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION

- updateInterval:

    Update interval.

- lockStatus:

    O: Locked - 1: NOT locked - 3: Unknown

- lock:

    lock

- unlock:

    Unlock the laser by setting the coarseTune to ID: 7

- 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

- stepLength:

    Step length used in Step Up/Step Down.

- zeroAngle:

    The position of the motor where the zero angle is defined

- offsetIntensity:

    Defines the lowest soft limit

- 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

- timeoutConnectToBCom:

    Timeout for succesfully connect to PLC

- timeoutReadDevConfig:

    Timeout for getting the same number of failures when reading the configuration of devices

- setDefaultDevConfig:

    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device

- outputFileRoot:

    Template string for output XML file

- inputFileTemplate:

    File with variables to save in FW

- configDir:

    Folder to store configuration files

- plcInFwTemplate:

    List of PLCs which have a specific configuration to save, as found in the FW Template

- instantiateDevices:

    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.

- instantiateQuick:

    Instantiate all devices on selected PLC quickly

- instantiateGroupDevices:

    Instantiate all selected group devices in selected PLC

- instantiateComponentDevices:

    Instantiate all selected component devices in selectedPLC

- resetDevices:

    Reset all devices in Error state

- getOfflineDevices:

    Check which devices are still offline

- shutdownDevices:

    Shutdown all devices

- shutdownGroupDevices:

    Shutdown all group devices

- shutdownComponentDevices:

    Shutdown all component devices

- getPLCsInFwTemplate:

    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.

- getPLCsInSystem:

    Get list of PLCs active in current topic

- handleMultiConfigToXML:

    The retrieved config of devices in PLCs is written on an XML file

- handleSingleConfigToXML:

    The retrieved config of devices in selected beckhoffId is written in XML file

- serverUri:

    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.

- serverTimeout:

    Timeout for server responses.

- autoResetTime:

    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.

- connectionSettlingTime:

    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number

- failedConnectionAttempts:

    Number of consecutive attempts to connect.

- plcUptime:

    Total time (in seconds), that the PLC server is up and running

- createGenericDevices:

    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.

- messageRateOut:

    The average rate of messages sent by BeckhoffCom

- messageRateIn:

    The average rate of messages received by BeckhoffCom

- byteRateOut:

    The average rate of bytes sent by BeckhoffCom

- byteRateIn:

    The average rate of bytes received by BeckhoffCom

- availablePlcDevices:

    Lists all available PLC devices

- updatesRate:

    The average rate of updates to the Beckhoff Devices

- devicesBlacklist:

    List of the devices that will not be instantiated automatically.

- instantiationInterval:

    The interval between consecutive instantiations

- ACpuFrequency:

    Frequency of the CPU.

- ACurrentCpuUsage:

    Current CPU usage.

- ACurrentCpuTemperature:

    Current temperature of the CPU.

- AProgramMemoryAllocated:

    Allocated program memory.

- AProgramMemoryAvailable:

    Available program memory.

- AStorageMemoryAllocated:

    Allocated storage-memory. Available on Windows CE.

- AStorageMemoryAvailable:

    Available storage-memory. Available on Windows CE.

- AMemoryDivision:

    MemoryDivision. Available on Windows CE.

- AProgramMemoryAllocated2:

    Allocated program memory.

- AProgramMemoryAvailable2:

    Available program memory.

- AMacAddess:

    MAC-Address of the PLC (17 char string).

- AIpv4Address:

    Current IPv4 Address of the PLC in dotted notation (15 char string).

- AIpv4SubnetMask:

    IPv4 subnet mask of the PLC in dotted notation (15 char string).

- ADhcpServerIpv4Address:

    IP-Address of the DHCP-Server in dotted notation (15 char string).

- ADhcpServerEnabled:

    True if the DHCP-Server is enabled.

- AMainboardType:

    Type of the main-board.

- ASerialNumber:

    Serial number.

- AProductionDate:

    Production date of the main-board.

- ABootCount:

    Boot count.

- AOperatingTimeInMinutes:

    Operating time of the main-board.

- AMinBoardTemperature:

    Minimum temperature of the main-board.

- AMaxBoardTemperature:

    Maximum temperature of the main-board.

- MinInputVoltage:

    Minimum input voltage of the main-board.

- MaxInputVoltage:

    Maximum input voltage of the main-board.

- MainboardTemperature:

    Current temperature of the main-board.

- APlcProjectVersion:

    PLC Project Version

- AProjectGeneratorVersion:

    Project Generator Version

- ATCPBufferSize:

    TCP/IP buffer size.

- ATrainID:

    Train ID

- ABeamModes:

    Beam Modes

- ATCPOutputDataRate:

    TCP Output Data Rate

- ATCPOutputBufLvlMax:

    TCP Output Buf Lvl Max

- ATCPInputDataRate:

    TCP Input Data Rate

- ATCPInputBufLvlMax:

    TCP Input Buf Lvl Max

- APLCCycleTime:

    PLC Cycle Time

- ignore:

    Ignore

- configure:

    Upload configuration parameters to the FEM

- monitor:

    Monitor

- record:

    Record

- tune:

    Tune

- toggle:

    Pause or resume a running acquisition.

- lastStatusMessage:

    Status message of last command

- loggerConfig:

    Runtime logger configuration

- policy:

    Errors handling policy

- ApplicationMonitor:

    Application health monitor

- BookKeeper:

    Book keeper

- BufferManager:

    Buffer manager

- DataAccessor0:

    Data accessor 0

- DataAccessor1:

    Data accessor 1

- DataDispatcher:

    Data dispatcher

- DataIntegrator:

    Data integrator

- DataMonitor:

    Data content monitor

- FastDataCollector:

    Fast data collector

- Formatter:

    Formatter

- InternalTrigger:

    Internal trigger

- MessageLogger:

    Message logger

- PreProcessor:

    Pre processor

- Scheduler:

    Scheduler

- SlowDataCollector:

    Slow data collector

- StatisticsBuilder:

    Statistics builder

- Summarizer:

    Data summarizer

- TrainDataReceiver:

    Train data receiver

- TrainReconstructor:

    Train data reconstructor

- Vectorizer:

    Data vectorizer

- Writer:

    Writer

- enableDaqNode:

    Enable DAQ node

- storageManager:

    Storage manager device

- groupId:

    Aggregators group Id

- groupInfix:

    Aggregators group infix

- channelId:

    channel Id

- channelsCount:

    Number of channels

- mountPoint:

    Mount point

- dataPath:

    Proposal data path

- chunkSize:

    Number of trains to buffer in memory

- chunksCount:

    Chunk count per file

- maxExpectedPulses:

    Maximum number of pulses expected per train

- dataType:

    Data type

- runController:

    The deviceId of the RunController to use, starts and stops daq.

- experimentDetails:

    Experiment details

- sampleDetails:

    Sample details

- runDetails:

    Run details

- enableXTDF:

    Enable receiving train data via UDP

- OriginalDataFormat:

    Name of file that contains the original data format description, include train data format, dataset and run info.

- Detector:

    Name of file that contains the detector configuration.

- timeServerId:

    The instance id uniquely identifies a TimeServer instance in the distributed system

- Logger:

    Logging settings

- configurations:

    All configuration groups and their sources

- sources:

    Overall list of data sources and their attributes

- operationMode:

    Operation mode

- metadataSchemaVersion:

    Metadata schema version

- proposalNumber:

    Proposal number

- experiment:

    Experiment

- sample:

    Sample

- runNumber:

    Run number

- user:

    User

- localConfiguration:

    Local configuration

- remoteConfiguration:

    Remote configuration

- debug:

    Debug mode

- 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

- group:

    Structure describing data sources logically belonging together.

- owner:

    The person to contact regarding usage of this group

- 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

- slotPushToDaq:

    Push run configuration to DAQ

- slotRetrieveProposalDetails:

    Retrieve proposal details

- actions:

    Actions

- defaultMaxSize:

    Default max size for vectors when this is not specified in data schema

- runConfigurator:

    The deviceId of the current RunConfigurator. It is filled automatically.

- dataManager:

    Data manager device

- proposalDataPath:

    Proposal data path

- runMsg:

    Run message

- trainId:

    Current Train Id(landmark)

- refTrainId:

    Method and offset for calculating the reference Train Id

- daqGlobalState:

    Global state of the DAQ system

- aggregators:

    Aggregators devices

- dataSourceToAggregatorsMapping:

    Data sources to aggregators mapping

- dataAggregators:

    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.

- clientId:

    Client Id

- daqManager:

    DAQ management system

- availableGroups:

    Avialable groups

- scanGroupsResult:

    Scan Results

- configuratorId:

    DAQ CONFIGURATOR device Id

- recentTrainId:

    Most recently published train ID from timeServer

- trainIdThreshold:

    Threshold for trainId

- checkTrainIdFrom:

    Return TrainId from device slot/configuration

- addWaitForData:

    This is in addition to how long the data aggregator waits

- strictTidTesting:

    If true, train ids in the future are not allowed.

- daqTimeout:

    The configuration timeout to wait for DAQ state changes

- autoFill:

    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.

- start:

    Starts acquisition

- setup:

    Configure the DAQ before acquisition and check device states.

- createGrid:

    Create a parallelogram with the following input

    > steps_x, steps_y, v_bl=None, v_br=None, v_tl=None, v_tr=None, exclude=”topRight”

- 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

- 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:

    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.

- 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’.

- availableMacros:

    Provides scan macros from the scan device

- output:

    Output Channel for the scan data

- abort:

    Call this slot to stop everything

- pause:

    Call this slot to pause or resume running scan

- proxy:

    The Clock and Control device

- uploadOk:

    Was the upload to Veto Memory Successful

- displayedSequence:

    Sequence generated from user input

- displayedBinOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered

- displayedOutput:

    The bits that are sent to the C&C, one entry for each bunch, ordered, human readable

- vetoMode:

    The mode in which to generate the pattern.

- inputString:

    The input can be valid python code, that generates either an integer, or an iterable of integers. When doing equations, remember to cast your floats to ints.

- saveVetoPatternFile:

    Save VETO pattern to disk file, as configured in the CCMon device

- uploadPatternFile:

    Upload VETO pattern from file into VETO memory, as configured in the CCMon device, and check that the upload was correct

- deviceNames:

    The LpdFem devices to be sub-control

- connectFem:

    Open connection to FEM

- disconnectFem:

    Close connection to FEM

- prepare:

    Prepare new configuration parameters for the FEM

- startDAQ:

    Start data acquisition

- stopDAQ:

    Stop acquisition immediately

- sync_params:

    Sets all composite parameters on fems.

- manual_recover:

    Try recovery from UNKNOWN after state desynchronization has been manually solved for the respective children.

- asicPowerEnable0:

    ASIC 0 LV Power Enable

- asicPowerEnable1:

    ASIC 1 LV Power Enable

- asicRxGainAlgorithmType:

    Set the ASIC gain selection algorithm type (0=Original with Fixed Thresholds at Full Scale, 1=Variable Thresholds using 64 levels; 2,3 reserved)

- asicRxGainThresholdx10:

    Set AsicRx Gain Select Threshold for x10 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- asicRxGainThresholdx100:

    Set AsicRx Gain Select Threshold for x100 (same value for all 128 asics); 1 (MIN) to 64 (FULL SCALE SIGNAL) ; used when asicRxGainAlgorithmType = 1

- cccEmulationMode:

    Enable to emulate Clock & Control commands (for testing in absence of C&C)

- cccProvideNumberImages:

    ASICs will send “numberImages” images (BUT only if cccSystemMode=2) True=C&C decides, False=Use numberImages

- cccResetDelay:

    Adjust timing of reset (in steps of clock cycles)

- cccStopDelay:

    Adjust timing of the stop (in steps of clock cycles)

- cccSystemMode:

    Clock & Control System Mode 0=Without C&C, 1=C&C without vetoes, 2=With C&C and vetoes

- cccVetoPatternFile:

    Filename containing the veto bunch pattern (10 patterns, 3072 bits each)

- cccVetoStartDelay:

    Adjust timing of veto arrival (in steps of clock cycles)

- femAsicClockSource:

    ASIC clock source 0=Fem local oscillator (100MHz), 1=XFEL synched clock (99 MHz), 2=PETRAIII synched clock (~114 MHz), 3=Diamond

- femAsicCmdSequence:

    ASIC Command Words defined in XML syntax

- femAsicCommandLength:

    ASIC length of command word in clock periods which determines ASIC sampling period; valid values are: 20 => 5 MHz ; 22 => 4.5 MHz (default XFEL 99MHz clock) ; 25 => 4.0 MHz ; 30 => 3.33 MHz ; 40 => 2.5 MHz ; 50 => 2.0 MHz ; 100 => 1.0 MHz

- femAsicDataType:

    ASIC data type 0=Sensor data, 1=FEM internal counting, 2=ASIC pseudorandom

- femAsicGain:

    Set the ASIC gain selection mode (0=ASIC algorithm, 1, 10, 100)

- femAsicPixelFeedbackOverride:

    ASIC pixel feedback override selection: 0=low(50pF), 1=high(5pF), -1=XML decides

- femAsicPixelSelfTestOverride:

    ASIC pixel self-test override selection: 0=off, 1-5=test selection, -1=XML decides

- femAsicSetupParams:

    ASIC Setup Parameters defined in XML syntax

- femInvertAdcData:

    Enable Invert ADC ASIC data True=Invert Data

- femPpcEmulatePipeline:

    Emulate Pipeline to compute the Pulse Number and Cell ID for the Image Descriptors

- femPpcImageReordering:

    Enable reordering images in readout by Pulse Number if femPpcEmulatePipeline enabled

- femPpcMode:

    Fem PPC mode 0=single train shot with PPC reset, 1=Continuous readout

- femStartTrainDelay:

    Delay between trigger arrival and start of train (in FEM clock cycles)

- femStartTrainInhibit:

    Inhibit period after each trigger (in FEM clock cycles) which holds off further triggers to allow data to be readout

- femStartTrainPolarity:

    Set polarity of the external signal indicating start of train 0=No inversion, 1=Invert signal

- femStartTrainSource:

    Train start signal source 0=XFEL Clock & Ctrl command/reset, 1=Software, 2=LCLS, 3=Petra (derived from PETRAIII clock), 4=Diamond

- femVetoPolarity:

    Set polarity of the external veto signal 0=No inversion, 1=Invert signal

- integrationCycles:

    Sets the number of integration cycles per images

- numPulsesInTrainOverride:

    Length of XRay Pulse Train (number pulses)

- numberImages:

    Sets the number of images per trigger

- numberTrains:

    Number of trains [if LL Data Generator or PPC Data Direct selected]

- sensorBias0:

    Sensor 0 HV Bias Voltage [V]

- sensorBias1:

    Sensor 1 HV Bias Voltage [V]

- sensorBiasEnable0:

    Sensor 0 HV Bias Enable

- sensorBiasEnable1:

    Sensor 1 HV Bias Enable

- tenGigInterframeGap:

    10GigE Inter-frame gap timer [clock cycles]

- tenGigUdpPacketLen:

    10GigE UDP packet payload length

- timeoutTrain:

    Timeout in seconds on waiting for next Train during run

- trainGenInterval:

    Interval (in 100 mhz clock periods) between internally generated Train start commands

- proxyCACML:

    The Clock and Control device

- fem:

    Device controlling Fem, can be composite

- ccMon:

    Device controlling clock & control.

- data_taking:

    Detector Device That Implements TakeData Function.

- x2Timer:

    The utca device

- cancel:

    Cancels last button pressed.

- femBootUpTime:

    Time needed for FEM to be responsive after powering up [s].

- asicBootUpTime:

    Time needed for asics to follow last commands [s].

- powerTimeout:

    Time needed for power to arrive at all FEMS [s].

- configTimeout:

    Time needed for femComposit to upload config

- scenarioConfig:

    Configuration of common operation scenarios

- emergencyShutdown:

    Power off quadrants immediately.

- uploadConfig:

    Sends selected configuration to detector.

- getReady:

    Bring detector in a state ready for data taking

- startDisablePower:

    Disable LPDpower & …

- disable:

    Disable FEM to be ignored

- enable:

    Enable FEM to be part of the system

- disabled:

    Disable FEM, will no longer be controlled by the composite

- sys_status:

    Status summary

- error_msg:

    Error message.

- sync_start_time:

    Unix timestamp to trigger start at

- femHost:

    FEM hostname or IP address

- femPort:

    FEM port number

- femTimeout:

    FEM connection timeout

- femAsicModuleType:

    Selects ASIC module type 0=Supermodule, 1=Single ASIC, 2=2-tile module, 3=Stand-alone

- femLegacyPowerCard:

    Enable legacy power card support

- tenGig0SourceMac:

    10GigE 0 UDP Source MAC Address

- tenGig0SourceIp:

    10GigE 0 UDP Source IP Address

- tenGig0SourcePort:

    10GigE 0 UDP Source Port

- tenGig0DestMac:

    10GigE 0 UDP Destination MAC Address

- tenGig0DestIp:

    10GigE 0 UDP Destination IP Address

- tenGig0DestPort:

    10GigE 0 UDP Destination Port

- femEnableTenGig:

    Enables transmission of image data via 10GigE UDP interface

- femDataSource:

    Source of data sent to 10GigE: 0=ASIC (via PPC), 1=ASIC (bypassing PPC), 2=Frame Generator, 3=PPC (pattern data)

- femAsicEnableMask:

    ASIC RX channel enable mask (4*32 bits)

- femReadoutOperatingMode:

    FEM readout operating mode (e.g. Normal, Self-test scan etc, TBD

- femAsicLocalClock:

    ASIC clock scaling 0=100 MHz (no scaling), 1=Scaled down clock (10 MHz)

- femAsicSetupLoadMode:

    ASIC control load mode 0=parallel, 1=daisy chain (being tested)

- femAsicRxCmdWordStart:

    Enable ASIC readout started by Command Word in femAsicCmdSequence file

- femAsicSetupClockPhase:

    ASIC Setup Params additional phase adjustment of clock rsync wrt ASIC reset

- tenGigFarmMode:

    10GigE farm mode 1=Disabled, 2=Fixed IP, multi port, 3=Farm mode with nic lists

- femAsicVersion:

    ASIC Version 1=version 1, 2=version 2

- femAsicGainOverride:

    Enable Fem gain selection override False=Gain set by femAsicGain, True=Gain set by Asic Command Sequence XML tag(s)

- femDebugLevel:

    Set the debug level

- tenGig0DataGenerator:

    10GigE 0 Data generator 1=Data Generator 2=PPC DDR2; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0DataFormat:

    10GigE 0 Data format type 0=counting data; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0FrameLength:

    10GigE 0 Frame length in bytes; Only relevant if femDataSource=2 [Frame Generator]

- tenGig0NumberOfFrames:

    10GigE 0 Number of frames to send in each cycle; Only relevant if femDataSource=2 [Frame Generator]

- femModuleId:

    ID for FEM to differentiate from which FEM data is coming from 0 - 15

- femAsicTestDataPatternType:

    Increment test data option [if femAsicDataType=1] 0=Every Pixel 1=Only Every Image

- femTrainIdInitLsw:

    Train ID initial (lower 32-bit) value, Not applicable for C&C nor Data Checker

- femTrainIdInitMsw:

    Train ID initial (upper 32-bit) value, Not applicable for C&C nor Data Checker

- powerCardFault0:

    Power Card 0 Fault Flag

- powerCardFault1:

    Power Card 1 Fault Flag

- powerCardFemStatus0:

    Power Card 0 FEM Status Flag

- powerCardFemStatus1:

    Power Card 1 FEM Status Flag

- powerCardExtStatus0:

    Power Card 0 External Status Flag

- powerCardExtStatus1:

    Power Card 1 External Status Flag

- powerCardOverCurrent0:

    Power Card 0 Overcurrent Flag

- powerCardOverCurrent1:

    Power Card 1 Overcurrent Flag

- powerCardOverTemp0:

    Power Card Over 0 Temperature Flag

- powerCardOverTemp1:

    Power Card Over 1 Temperature Flag

- powerCardUnderTemp0:

    Power Card Under 0 Temperature Flag

- powerCardUnderTemp1:

    Power Card Under 1 Temperature Flag

- powerCardTemp0:

    Power Card 0 Temperature [C]

- powerCardTemp1:

    Power Card 1 Temperature [C]

- sensor0Temp:

    Sensor 0 Temperature [C]

- sensor1Temp:

    Sensor 1 Temperature [C]

- sensor2Temp:

    Sensor 2 Temperature [C]

- sensor3Temp:

    Sensor 3 Temperature [C]

- sensor4Temp:

    Sensor 4 Temperature [C]

- sensor5Temp:

    Sensor 5 Temperature [C]

- sensor6Temp:

    Sensor 6 Temperature [C]

- sensor7Temp:

    Sensor 7 Temperature [C]

- sensor8Temp:

    Sensor 8 Temperature [C]

- sensor9Temp:

    Sensor 9 Temperature [C]

- sensor10Temp:

    Sensor 10 Temperature [C]

- sensor11Temp:

    Sensor 11 Temperature [C]

- sensor12Temp:

    Sensor 12 Temperature [C]

- sensor13Temp:

    Sensor 13 Temperature [C]

- sensor14Temp:

    Sensor 14 Temperature [C]

- sensor15Temp:

    Sensor 15 Temperature [C]

- femVoltage0:

    FEM 5V Supply 0 Voltage [V]

- femVoltage1:

    FEM 5V Supply 1 Voltage [V]

- femCurrent0:

    FEM 5V Supply 0 Current [A]

- femCurrent1:

    FEM 5V Supply 1 Current [A]

- digitalVoltage0:

    ASIC 1.2V Digital Supply 0 Voltage [V]

- digitalVoltage1:

    ASIC 1.2V Digital Supply 1 Voltage [V]

- digitalCurrent0:

    ASIC 1.2V Digital Supply 0 Current [mA]

- digitalCurrent1:

    ASIC 1.2V Digital Supply 1 Current [mA]

- sensor0Voltage:

    Sensor 0 3.3V Supply Voltage [V]

- sensor1Voltage:

    Sensor 1 3.3V Supply Voltage [V]

- sensor2Voltage:

    Sensor 2 3.3V Supply Voltage [V]

- sensor3Voltage:

    Sensor 3 3.3V Supply Voltage [V]

- sensor4Voltage:

    Sensor 4 3.3V Supply Voltage [V]

- sensor5Voltage:

    Sensor 5 3.3V Supply Voltage [V]

- sensor6Voltage:

    Sensor 6 3.3V Supply Voltage [V]

- sensor7Voltage:

    Sensor 7 3.3V Supply Voltage [V]

- sensor8Voltage:

    Sensor 8 3.3V Supply Voltage [V]

- sensor9Voltage:

    Sensor 9 3.3V Supply Voltage [V]

- sensor10Voltage:

    Sensor 10 3.3V Supply Voltage [V]

- sensor11Voltage:

    Sensor 11 3.3V Supply Voltage [V]

- sensor12Voltage:

    Sensor 12 3.3V Supply Voltage [V]

- sensor13Voltage:

    Sensor 13 3.3V Supply Voltage [V]

- sensor14Voltage:

    Sensor 14 3.3V Supply Voltage [V]

- sensor15Voltage:

    Sensor 15 3.3V Supply Voltage [V]

- sensor0Current:

    Sensor 0 3.3V Supply Current [A]

- sensor1Current:

    Sensor 1 3.3V Supply Current [A]

- sensor2Current:

    Sensor 2 3.3V Supply Current [A]

- sensor3Current:

    Sensor 3 3.3V Supply Current [A]

- sensor4Current:

    Sensor 4 3.3V Supply Current [A]

- sensor5Current:

    Sensor 5 3.3V Supply Current [A]

- sensor6Current:

    Sensor 6 3.3V Supply Current [A]

- sensor7Current:

    Sensor 7 3.3V Supply Current [A]

- sensor8Current:

    Sensor 8 3.3V Supply Current [A]

- sensor9Current:

    Sensor 9 3.3V Supply Current [A]

- sensor10Current:

    Sensor 10 3.3V Supply Current [A]

- sensor11Current:

    Sensor 11 3.3V Supply Current [A]

- sensor12Current:

    Sensor 12 3.3V Supply Current [A]

- sensor13Current:

    Sensor 13 3.3V Supply Current [A]

- sensor14Current:

    Sensor 14 3.3V Supply Current [A]

- sensor15Current:

    Sensor 15 3.3V Supply Current [A]

- sensorBiasVoltage0:

    Sensor bias 0 voltage readback [V]

- sensorBiasVoltage1:

    Sensor bias 1 voltage readback [V]

- sensorBiasCurrent0:

    Sensor bias 0 current readback [uA]

- sensorBiasCurrent1:

    Sensor bias 1 current readback [uA]

- femV5FirmwareVersion:

    FEM V5 Firmware Version

- femBotSp3FirmwareVersion:

    FEM Bottom SP3 FPGA Firmware Version

- femTopSp3FirmwareVersion:

    FEM Top SP3 FPGA Firmware Version

- femCfgSp3FirmwareVersion:

    FEM Config SP3 FPGA Firmware Version

- femLpdClientVersion:

    LpdFemClient Software Version - Read Only

- femReadoutActive:

    FEM readout is active

- femBoardTemperature:

    FEM Board Sensor Temperature [C] Reading

- femCoreTemperature:

    FEM Core Sensor Temperature [C] Reading

- auto_mode:

    Configure default configuration when taking darks

- take_dark_frames:

    Take set of dark frames.

- startScan:

    Value with which to start scan.

- stopScan:

    Value around which to stop scan. Depends on start value and step size if it is reached exactly.

- nSteps:

    Number of steps in the intervall between start and stop.

- optWithCCMon:

    To choose delay scan with or without C&C

- delayScanSleepTime:

    Time needed for X2Timer to delay scan with C&C [s].

- delayScan:

    Start delay scan.

- runControl:

    Device controlling run management.

- self_check:

    Check if all conditions are ok for data taking.

- control:

    Control of system variables

- powerEnable:

    Allow all quadrants to receive power.

- powerDisable:

    Forbid all quadrants to receive power.

- armInterlock:

    Arm interlock to be able to power quadrants.

- disarmInterlock:

    Disarm interlock, no power allowed to quadrants.

- quad1:

    Quad1 node

- quad4:

    Quad4 node

- quad2:

    Quad2 node

- quad3:

    Quad3 node

- temperature:

    Camera temperature. Not available for all models.

- humidity:

    Humidity sensors

- leakimpedance:

    Leak sensors

- pump:

    Pump variables

- fan:

    Fan variables

- 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

- 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

- value:

    Analog input of ADC.

- semiRawValue:

    Semi raw value of analog input, i.e. the voltage.

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- relativeEpsilon:

    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

- inFrameRate:

    The input frame rate.

- resetError:

    Reset error count.

- resetAverage:

    Reset averaged image.

- imagePath:

    Input image path.

- nImages:

    Number of images to be averaged.

- runningAverage:

    Calculate running average (instead of standard).

- runningAvgMethod:

    The algorithm used for calculating the running average.

- outFrameRate:

    The output frame rate.

- connectCamera:

    Connects to the hardware

- acquire:

    Instructs camera to go into acquisition state

- frameRate:

    The rate of frames received from camera.

- frameRateOut:

    Frame rate - decoded data to output channels.

- cameraType:

    The camera type.

- cameraModel:

    The camera model.

- imageDepth:

    The image depth in bytes.

- triggerMode:

    The trigger mode.

- exposureTime:

    exposure time value

- latencyTime:

    The latency time.

- nbFrames:

    The number of frames for an acquisition. 0 means unlimited.

- rotation:

    The image rotation.

- pollingInterval:

    The interval for polling the laser front-end for status.

- bufferSize:

    Size of the buffer for data to be written to output channels.

- cameraIp:

    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.

- interPacketDelay:

    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.

- frameTransmissionDelay:

    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues

- packetSize:

    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.

- socketBufferSize:

    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.

- autoGain:

    Set auto gain.

- gain:

    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %

- triggerActivation:

    The Trigger Activation parameter is used to select rising edge or falling edge triggering.

- imageType:

    This parameter is used to select the pixel format.

- acqFrameCount:

    This parameter is used to set the number of frames acquired in the multiframe acquisition mode

- extractedLabels:

    Out positions: labels, where the imager is extracted from the beam.

- tolerance:

    Position tolerance for increment detection

- moveOUT:

    Moves the motor to the position marked with this label

- moveC:

    Moves the motor to the position marked with this label

- moveC/:

    Moves the motor to the position marked with this label

- moveYAG:

    Moves the motor to the position marked with this label

- useAsBackgroundImage:

    Use the current image as background image.

- filterImagesByThreshold:

    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.

- imageThreshold:

    The threshold for processing an image.

- absolutePositions:

    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.

- subtractBkgImage:

    Subtract the loaded background image.

- subtractImagePedestal:

    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.

- doMinMaxMean:

    Get the following information from the pixels: min, max, mean value.

- doBinCount:

    Calculate the frequency distribution of pixel values.

- doXYSum:

    Integrate the image along the x- and y-axes.

- doCOfM:

    Calculate centre-of-mass and widths.

- do1DFit:

    Perform a 1D gaussian fit of the x- and y-distributions.

- do2DFit:

    Perform a 2D gaussian fits.Be careful: It can be slow!

- doIntegration:

    Perform integration over region.

- clipValues:

    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.

- comRange:

    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.

- userDefinedRange:

    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- absThreshold:

    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.

- threshold:

    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.

- pixelSize:

    The pixel size. It will be used when evaluating the beam size.

- fitRange:

    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.

- rangeForAuto:

    The automatic range for ‘auto’ mode (in standard deviations).

- enablePolynomial:

    Add a 1st order polynomial term (ramp) to gaussian fits.

- gauss1dStartValues:

    Selects how 1D gauss fit starting values are evaluated

- doGaussRotation:

    Allow the 2D gaussian to be rotated.

- integrationRegion:

    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]

- thresholdRange:

    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.

- imageWidth:

    The width of the incoming image.

- imageOffsetX:

    If the incoming image has a ROI, this represents the X position of the top-left corner.

- imageBinningX:

    The image binning in the X direction.

- imageHeight:

    The height of the incoming image. Set to 1 for 1D images (spectra).

- imageOffsetY:

    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).

- imageBinningY:

    The image binning in the Y direction. Set to 1 for 1D images (spectra).

- minPxValue:

    The minimum image pixel value.

- maxPxValue:

    The maximum image pixel value.

- meanPxValue:

    The mean image pixel value.

- minMaxMeanTime:

    Time spent for evaluating min, max, mean pixel value.

- binCountTime:

    Time spent for calculating the frequency distribution of pixel values.

- subtractBkgImageTime:

    Time spent in subtracting the background image.

- subtractPedestalTime:

    Time spent in subtracting the image pedestal.

- xYSumTime:

    Time spent in integrating the image in X and Y.

- cOfMTime:

    Time spent in evaluating the centre-of-mass.

- xFitTime:

    Time spent in 1D Gaussian fit of the X distribution.

- yFitTime:

    Time spent in 1D Gaussian fit of the Y distribution.

- fitTime:

    Time spent in 2D Gaussian fit of the image.

- integrationTime:

    Time spent in integrating over a region.

- x0:

    X position of the centre-of-mass.

- sx:

    Standard deviation in X of the centre-of-mass.

- y0:

    Y position of the centre-of-mass.

- sy:

    Standard deviation in Y of the centre-of-mass.

- xFitSuccess:

    1D Gaussian fit success (1-4 if fit converged).

- ax1d:

    Amplitude Ax from the 1D fit.

- x01d:

    x0 from 1D Fit.

- ex01d:

    Uncertainty on x0 estimation.

- sx1d:

    Standard deviation on x0 from 1D fit.

- esx1d:

    Uncertainty on standard deviation estimation.

- beamWidth1d:

    Beam width from 1D Fit. Defined as 4x sigma_x.

- yFitSuccess:

    1D Gaussian Fit Success (1-4 if fit converged).

- ay1d:

    Amplitude Ay from 1D fit.

- y01d:

    y0 from 1D Fit.

- ey01d:

    Uncertainty on y0 estimation.

- sy1d:

    Standard deviation on y0 from 1D fit.

- esy1d:

    Uncertainty on standard deviation estimation.

- beamHeight1d:

    Beam heigth from 1D Fit. Defined as 4x sigma_y.

- fitSuccess:

    2D Gaussian fit success (1-4 if fit converged).

- a2d:

    Amplitude from 2D fit.

- x02d:

    x0 from 2D Fit.

- ex02d:

    Uncertainty on x0 estimation.

- sx2d:

    Standard deviation on x0 from 2D fit.

- esx2d:

    Uncertainty on standard deviation estimation.

- beamWidth2d:

    Beam width from 2D Fit. Defined as 4x sigma_x.

- y02d:

    y0 from 2D Fit.

- ey02d:

    Uncertainty on y0 estimation.

- sy2d:

    Standard deviation on y0 from 2D fit.

- esy2d:

    Uncertainty on standard deviation estimation.

- beamHeight2d:

    Beam height from 2D Fit. Defined as 4x sigma_y.

- theta2d:

    Rotation angle from 2D fit.

- etheta2d:

    Uncertainty on rotation angle estimation.

- regionIntegral:

    Integral of pixel value over region specified by integrationRegion.

- regionMean:

    Mean pixel value over region specified by integrationRegion.

- moveC1:

    Moves the motor to the position marked with this label

- moveC2:

    Moves the motor to the position marked with this label

- bkg:

    The background on ADC counts.

- cal:

    The calibration constants [keV/counts].

- averagedDisplay:

    Average all the frames in the train and then display.

- frameToDisplay:

    The index of the frame to be displayed in the train, starting from 0.

- useBackgroundFrame:

    Use Frame for Background subtraction

- frameNumber:

    The index of the frame to be used for background subtraction

- errorCount:

    Number of errors.

- 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.

- onlineDisplayEnable:

    Enable online display of detector data.

- 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

- 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)

- extSig0:

    Ext Sig 0

- vHighVoltageMax:

    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.

- vHighVoltage:

    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200

- master:

    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.

- sync:

    Sets the synchronization mode of the various controller within a detector structure

- badChannels:

    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.

- angConv:

    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.

- globalOff:

    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.

- binSize:

    Sets the size of the angular bins for angular conversion.

- threaded:

    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).

- detectorDeveloper:

    Detector Developer. (useful to define subset of working functions)

- flatFieldCorrectionFile:

    Flat field corrections file name. Use ‘none’ to disable corrections.

- positions:

    Positions for the acquisition. Usage: n pos1 pos2 … posn

- maximumDetectorSize:

    Maximum detector size

- bitDepth:

    Bit Depth

- exposurePeriod:

    exposure period

- delayAfterTrigger:

    delay after trigger

- numberOfGates:

    Number Of Gates

- numberOfFrames:

    Number Of Frames

- numberOfCycles:

    Number Of Cycles

- timing:

    The timing mode of the detector

- triggerPeriod:

    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.

- detectorNumber:

    Returns the serial number of the module (normally the MAC address).

- detectorVersion:

    Returns the version of the controller firmware.

- softwareVersion:

    Returns the version of the software running on the detector.

- thisVersion:

    Returns the version of the control software which is being used.

- tempAdc:

    Returns the ADC temperature.

- tempFpga:

    Returns the FPGA temperature.

- detectorMac:

    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.

- rOnline:

    rOnline

- roi:

    The user-defined region of interest (ROI), specified as [lowX, highX, lowY, highY]. [0, 0, 0, 0] will be interpreted as ‘whole range’.

- xIntegral:

    Integrate the image in X direction. By default integral is done over Y.

- spectrumIntegral:

    Integral of the spectrum, after applying ROI.

Release History
1.7.2-2.8.3

Created: | 2020-04-30T12:40:13.000Z
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T05:03:42.000Z
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T09:29:59.000Z
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

##### ENC

###### TARGET_IN_OUT

Instance id: | FXE_OGT1_TAD/ENC/TARGET_IN_OUT
Host: | exflcon06n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
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.9-2.6.1
Projects: | FXE_OGT1_TAD, FXE_OGT1_TAD, FXE_LOOP2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### TARGET_IN_OUT

##### TSENS

###### B4C_TEMP1

Instance id: | FXE_OGT1_TAD/TSENS/B4C_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_TAD
Scenes: | FXE_OGT1_TAD/TSENS/B4C_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### B4C_TEMP2

Instance id: | FXE_OGT1_TAD/TSENS/B4C_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_TAD
Scenes: | FXE_OGT1_TAD/TSENS/B4C_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FOIL_TEMP1

Instance id: | FXE_OGT1_TAD/TSENS/FOIL_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_TAD
Scenes: | FXE_OGT1_TAD/TSENS/FOIL_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FOIL_TEMP2

Instance id: | FXE_OGT1_TAD/TSENS/FOIL_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT1_TAD
Scenes: | FXE_OGT1_TAD/TSENS/FOIL_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### VAC

##### DCTRL

###### ATT_CC

Instance id: | FXE_OGT1_VAC/DCTRL/ATT_CC
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_LOOP1, FXE_OGT1_VAC
Scenes: | FXE_OGT1_VAC/DCTRL/ATT_CC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ATT_IP75_on_setpoint

Instance id: | FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint
Class id: | BeckhoffDigitalOutput
Host: | exflcon07n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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: | FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Global interlock (overview), FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### GV1_OPEN

Instance id: | FXE_OGT1_VAC/DCTRL/GV1_OPEN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### GV2_OPEN

Instance id: | FXE_OGT1_VAC/DCTRL/GV2_OPEN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INTERLOCK_ACTIV

Instance id: | FXE_OGT1_VAC/DCTRL/INTERLOCK_ACTIV
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INTERLOCK_BRIDGED

Instance id: | FXE_OGT1_VAC/DCTRL/INTERLOCK_BRIDGED
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PSLIT1_FR_value

Instance id: | FXE_OGT1_VAC/DCTRL/PSLIT1_FR_value
Class id: | BeckhoffDigitalOutput
Host: | exflcon07n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### PSLIT1_IP150_on_setpoint

Instance id: | FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint
Class id: | BeckhoffDigitalOutput
Host: | exflcon07n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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: | FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint, FXE_RR_SYS/ILOCK/MAIN|Global interlock (overview)
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### SA1_CC

Instance id: | FXE_OGT1_VAC/DCTRL/SA1_CC
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_OGT1_VAC, FXE_LOOP1
Scenes: | VACUUM_OVERVIEW, FXE_OGT1_VAC/DCTRL/SA1_CC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SA1_IP150_on_setpoint

Instance id: | FXE_OGT1_VAC/DCTRL/SA1_IP150_on_setpoint
Class id: | BeckhoffDigitalOutput
Host: | exflcon07n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### TAD_CC

Instance id: | FXE_OGT1_VAC/DCTRL/TAD_CC
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_OGT1_VAC, FXE_LOOP1
Scenes: | FXE_OGT1_VAC/DCTRL/TAD_CC_ON
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PSLIT1

FR
value

Instance id: | FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value
Class id: | BeckhoffDigitalOutput
Host: | exflcon07n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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: | FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Global interlock (overview)
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### ATT_IP75_ON_SETPOINT

Instance id: | FXE_OGT1_VAC/DCTRL/ATT_IP75_ON_SETPOINT
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PSLIT1_FR_VALUE

Instance id: | FXE_OGT1_VAC/DCTRL/PSLIT1_FR_VALUE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PSLIT1_IP150_ON_SETPOINT

Instance id: | FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_ON_SETPOINT
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SA1_IP150_ON_SETPOINT

Instance id: | FXE_OGT1_VAC/DCTRL/SA1_IP150_ON_SETPOINT
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### ATT_CC

Instance id: | FXE_OGT1_VAC/GAUGE/ATT_CC
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_LOOP1, FXE_OGT1_VAC
Scenes: | FXE_OGT1_VAC/GAUGE/ATT_CC
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PSLIT1_FR

Instance id: | FXE_OGT1_VAC/GAUGE/PSLIT1_FR
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_OGT1_VAC, FXE_LOOP1
Scenes: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT1_VAC/GAUGE/PSLIT1_FR, He-decon-GAUGES, VACUUM_OVERVIEW, FXE_OGT1_VAC/GAUGE/PSLIT1_FR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SA1_CC

Instance id: | FXE_OGT1_VAC/GAUGE/SA1_CC
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_LOOP1, FXE_OGT1_VAC
Scenes: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT1_VAC/GAUGE/SA1_CC, He-decon-GAUGES, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/ICTRL/PSLIT1_SA1_PUMP_CTL, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SA1_FR

Instance id: | FXE_OGT1_VAC/GAUGE/SA1_FR
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_OGT1_VAC, FXE_LOOP1
Scenes: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT1_VAC/GAUGE/SA1_FR, FXE_OGT1_VAC/GAUGE/SA1_FR, He-decon-GAUGES, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/ICTRL/PSLIT1_SA1_PUMP_CTL, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TAD_CC

Instance id: | FXE_OGT1_VAC/GAUGE/TAD_CC
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_LOOP1, FXE_OGT1_VAC
Scenes: | FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT1_VAC/GAUGE/TAD_CC, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/ICTRL/PSLIT1_SA1_PUMP_CTL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### ATT_PUMP_CTL

Instance id: | FXE_OGT1_VAC/ICTRL/ATT_PUMP_CTL
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_OGT1_VAC, FXE_LOOP1
Scenes: | FXE_OGT1_VAC/ICTRL/ATT_PUMP_CTL, FXE_OGT1_VAC/ICTRL/ATT_PUMP_CTL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### PSLIT1_SA1_PUMP_CTL

Instance id: | FXE_OGT1_VAC/ICTRL/PSLIT1_SA1_PUMP_CTL
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC
Scenes: | FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT1_VAC/ICTRL/PSLIT1_SA1_PUMP_CTL, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/ICTRL/PSLIT1_SA1_PUMP_CTL, FXE_RR_SYS/ILOCK/MAIN|Global interlock (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.
- 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

###### ATT_IP55

Instance id: | FXE_OGT1_VAC/IPUMP/ATT_IP55
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_OGT1_VAC, FXE_LOOP1
Scenes: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT1_VAC/IPUMP/ATT_IP55, He-decon-IPUMPS, VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint, FXE_OGT1_VAC/IPUMP/ATT_IP55
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### PSLIT1_IP150

Instance id: | FXE_OGT1_VAC/IPUMP/PSLIT1_IP150
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_LOOP1, FXE_OGT1_VAC
Scenes: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT1_VAC/IPUMP/PSLIT1_IP150, He-decon-IPUMPS, FXE_OGT1_VAC/IPUMP/PSLIT1_IP150, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint, VACUUM_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.
- 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

###### SA1_IP150

Instance id: | FXE_OGT1_VAC/IPUMP/SA1_IP150
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT1_VAC, FXE_OGT1_VAC, FXE_LOOP1
Scenes: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_RR_SYS/ILOCK/MAIN|Global interlock, VAC-SIGNALS, FXE_OGT1_VAC/IPUMP/SA1_IP150, He-decon-IPUMPS, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/ICTRL/PSLIT1_SA1_PUMP_CTL, VACUUM_OVERVIEW, VAC-SIGNALS, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV1, FXE_OGT1_VAC/IPUMP/SA1_IP150
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### ATT_IP75_on_setpoint

Instance id: | FXE_OGT1_VAC/SWITCH/ATT_IP75_on_setpoint
Class id: | BeckhoffDigitalInput
Host: | exflcon06n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT2_VAC
Scenes: | FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- resetCounter:
    Reset count of edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.

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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### GV1_OPEN

Instance id: | FXE_OGT1_VAC/SWITCH/GV1_OPEN
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | INTERLOCK_SIGNALS, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### GV2_OPEN

Instance id: | FXE_OGT1_VAC/SWITCH/GV2_OPEN
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | INTERLOCK_SIGNALS, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### INTERLOCK_KEY_NC

Instance id: | FXE_OGT1_VAC/SWITCH/INTERLOCK_KEY_NC
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### INTERLOCK_KEY_NO

Instance id: | FXE_OGT1_VAC/SWITCH/INTERLOCK_KEY_NO
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PSLIT1_FR_value

Instance id: | FXE_OGT1_VAC/SWITCH/PSLIT1_FR_value
Class id: | BeckhoffDigitalInput
Host: | exflcon06n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT2_VAC
Scenes: | FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- resetCounter:
    Reset count of edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.

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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### PSLIT1_IP150_on_setpoint

Instance id: | FXE_OGT1_VAC/SWITCH/PSLIT1_IP150_on_setpoint
Class id: | BeckhoffDigitalInput
Host: | exflcon06n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT2_VAC
Scenes: | FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- resetCounter:
    Reset count of edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.

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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### ATT_IP75_ON_SETPOINT

Instance id: | FXE_OGT1_VAC/SWITCH/ATT_IP75_ON_SETPOINT
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PSLIT1_FR_VALUE

Instance id: | FXE_OGT1_VAC/SWITCH/PSLIT1_FR_VALUE
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PSLIT1_IP150_ON_SETPOINT

Instance id: | FXE_OGT1_VAC/SWITCH/PSLIT1_IP150_ON_SETPOINT
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COND_GV1

Instance id: | FXE_OGT1_VAC/VALVE/COND_GV1
Class id: | ConditionValve
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/conditionValve
Last modified: | 2020-11-24T12:43:17.000+01:00
Created at: | 2018-06-12T17:54:26.000+02:00
Main authors: | Hauf, Haufs, Degon
Latest tag: | 1.0.1-2.10.0
Deployment tag: | 1.0.1-2.10.0
Scenes: | VACUUM_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
- open:
    Open the valve without any conditions
- close:
    The software save slot close option

Release History
1.0.1-2.10.0

Created: | 2020-11-23T18:19:35.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.1-2.2.4

Created: | 2018-09-19T15:11:26.000+02:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.4

Created: | 2018-06-18T17:41:52.000+02:00
Author: | Dennis Goeries
Notes: |

###### COND_GV2

Instance id: | FXE_OGT1_VAC/VALVE/COND_GV2
Class id: | ConditionValve
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/conditionValve
Last modified: | 2020-11-24T12:43:17.000+01:00
Created at: | 2018-06-12T17:54:26.000+02:00
Main authors: | Hauf, Haufs, Degon
Latest tag: | 1.0.1-2.10.0
Deployment tag: | 1.0.1-2.10.0
Scenes: | VACUUM_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
- open:
    Open the valve without any conditions
- close:
    The software save slot close option

Release History
1.0.1-2.10.0

Created: | 2020-11-23T18:19:35.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.1-2.2.4

Created: | 2018-09-19T15:11:26.000+02:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.4

Created: | 2018-06-18T17:41:52.000+02:00
Author: | Dennis Goeries
Notes: |

##### 2

Instance id: | FXE_OGT1_VAC/2
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

###### Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

#### VAC2

Instance id: | FXE_OGT1_VAC2
Host: | exflcon07n0
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

#### LAS

##### MOTOR

###### MIRROR_Y

##### MDL

[add component documentation]

###### MAIN

Instance id: | FXE_OGT1_LAS/MDL/MAIN
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-1
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-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: | FXE_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!

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
- moveIN:
    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: |

### OGT2

#### BIU-1

##### AVG

###### CAMERA

Instance id: | FXE_OGT2_BIU-1/AVG/CAMERA
Class id: | ImageAverager
Host: | exflcon06n0
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image 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

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### ENC

###### SCREEN_Y

Instance id: | FXE_OGT2_BIU-1/ENC/SCREEN_Y
Host: | exflcon06n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
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.9-2.6.1
Projects: | FXE_OGT2_BIU-1, FXE_OGT2_BIU-1, FXE_LOOP2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MDL

###### MAIN

Instance id: | FXE_OGT2_BIU-1/MDL/MAIN
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-2
Alias: | fxe-rr-sys-con-2
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: | FXE_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!

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
- moveC:
    Moves the motor to the position marked with this label
- moveout:
    Moves the motor to the position marked with this label
- moveYAG:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

###### SCREEN_Y

##### PROC

###### CAMERA

Instance id: | FXE_OGT2_BIU-1/PROC/CAMERA
Class id: | ImageProcessor
Host: | exflcon06n0
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FXE_OGT2-BIU-1 Positions
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### TSENS

###### ROD_TEMP1

Instance id: | FXE_OGT2_BIU-1/TSENS/ROD_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_BIU-1, FXE_LOOP2, FXE_OGT2_BIU-1
Scenes: | FXE_OGT2_BIU-1/TSENS/ROD_TEMP1, FXE_OGT2_BIU-1/TSENS/ROD_TEMP1, FXE_OGT2_BIU-1-CAM-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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD_TEMP2

Instance id: | FXE_OGT2_BIU-1/TSENS/ROD_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_BIU-1, FXE_OGT2_BIU-1, FXE_LOOP2
Scenes: | FXE_OGT2_BIU-1/TSENS/ROD_TEMP2, FXE_OGT2_BIU-1/TSENS/ROD_TEMP2, FXE_OGT2_BIU-1-CAM-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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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]

###### LED

#### BIU-2

##### CAM

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### ENC

###### SCREEN_Y

Instance id: | FXE_OGT2_BIU-2/ENC/SCREEN_Y
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-02-07T15:31:28.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
Projects: | FXE_OGT2_BIU-2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

[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

###### MAIN

Instance id: | FXE_OGT2_BIU-2/MDL/MAIN
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-4
Alias: | fxe-rr-sys-con-4
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: | FXE_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!

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
- moveC:
    Moves the motor to the position marked with this label
- moveOUT:
    Moves the motor to the position marked with this label
- moveYAG:
    Moves the motor to the position marked with this label
- moveC_:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

###### SCREEN_Y

##### PROC

###### CAMERA

Instance id: | FXE_OGT2_BIU-2/PROC/CAMERA
Class id: | ImageProcessor
Host: | fxe-rr-sys-con-4
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-4
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
Scenes: | Min Max X & Y, BIU_OVERVIEW
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!

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, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The 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
- 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

###### ROD_TEMP1

Instance id: | FXE_OGT2_BIU-2/TSENS/ROD_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT2_BIU-2
Scenes: | FXE_OGT2_BIU-2/TSENS/ROD_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD_TEMP2

Instance id: | FXE_OGT2_BIU-2/TSENS/ROD_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-4
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT2_BIU-2
Scenes: | FXE_OGT2_BIU-2/TSENS/ROD_TEMP2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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]

###### CAMERA

Instance id: | FXE_OGT2_BIU-2/AVG/CAMERA
Class id: | ImageAverager
Host: | exflcon11n0
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image 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.

##### DCTRL

[add component documentation]

###### LED

#### CRL

##### ENC

###### CHAM_AX

Instance id: | FXE_OGT2_CRL/ENC/CHAM_AX
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CHAM_AY

Instance id: | FXE_OGT2_CRL/ENC/CHAM_AY
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CHAM_X

Instance id: | FXE_OGT2_CRL/ENC/CHAM_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CHAM_Y

Instance id: | FXE_OGT2_CRL/ENC/CHAM_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CHAM_Z

Instance id: | FXE_OGT2_CRL/ENC/CHAM_Z
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS10_X

Instance id: | FXE_OGT2_CRL/ENC/LENS10_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS10_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS10_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS1_X

Instance id: | FXE_OGT2_CRL/ENC/LENS1_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS1_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS1_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS2_X

Instance id: | FXE_OGT2_CRL/ENC/LENS2_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS2_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS2_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS3_X

Instance id: | FXE_OGT2_CRL/ENC/LENS3_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS3_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS3_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS4_X

Instance id: | FXE_OGT2_CRL/ENC/LENS4_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS4_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS4_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS5_X

Instance id: | FXE_OGT2_CRL/ENC/LENS5_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS5_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS5_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS6_X

Instance id: | FXE_OGT2_CRL/ENC/LENS6_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS6_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS6_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS7_X

Instance id: | FXE_OGT2_CRL/ENC/LENS7_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS7_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS7_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS8_X

Instance id: | FXE_OGT2_CRL/ENC/LENS8_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS8_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS8_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS9_X

Instance id: | FXE_OGT2_CRL/ENC/LENS9_X
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### LENS9_Y

Instance id: | FXE_OGT2_CRL/ENC/LENS9_Y
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_CRL
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### 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: | FXE_OGT2_CRL/TSENS/LENS10_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS10_T1, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS10_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS10_T2, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS1_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS1_T1, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS1_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS1_T2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS2_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS2_T1, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS2_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS2_T2, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS3_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS3_T1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS3_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS3_T2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS4_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS4_T1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS4_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS4_T2, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS5_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS5_T1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS5_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS5_T2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS6_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS6_T1, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS6_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS6_T2, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS7_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS7_T1, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS7_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS7_T2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS8_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS8_T1, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS8_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | FXE_OGT2_CRL/TSENS/LENS8_T2, OVERVIEW_OGT2_CRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS9_T1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS9_T1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT2_CRL/TSENS/LENS9_T2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_CRL
Scenes: | OVERVIEW_OGT2_CRL, FXE_OGT2_CRL/TSENS/LENS9_T2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### MAIN

Instance id: | FXE_OGT2_CRL/MDL/MAIN
Class id: | CompoundRefractiveLens
Host: | fxe-rr-sys-con-3
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/compoundRefractiveLens
Last modified: | 2021-05-27T15:24:47.000+02:00
Created at: | 2017-03-07T13:50:52.000+01:00
Main authors: | Hauf, Haufs, Schaffer
Latest tag: | 1.3.0-2.11.0
Deployment tag: | 1.3.0-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, 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: |

#### MOV

##### MOTOR

###### X_1

###### X_2

###### Y_1

###### Y_2

###### Y_3

#### PSLIT

##### ENC

###### BLADE1_IN_OUT

Instance id: | FXE_OGT2_PSLIT/ENC/BLADE1_IN_OUT
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_PSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE2_IN_OUT

Instance id: | FXE_OGT2_PSLIT/ENC/BLADE2_IN_OUT
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_PSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE3_IN_OUT

Instance id: | FXE_OGT2_PSLIT/ENC/BLADE3_IN_OUT
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_PSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### BLADE4_IN_OUT

Instance id: | FXE_OGT2_PSLIT/ENC/BLADE4_IN_OUT
Host: | exflcon09n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_OGT2_PSLIT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MDL

###### MAIN

Instance id: | FXE_OGT2_PSLIT/MDL/MAIN
Class id: | SlitSystem
Host: | fxe-rr-sys-con-3
Alias: | fxe-rr-sys-con-3
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: | FXE_OGT2_PSLIT/MDL/MAIN|SimpleControl, FXE_OGT2_PSLIT/MDL/MAIN|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

###### BLADE1_IN_OUT

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.

###### BLADE2_IN_OUT

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.

###### BLADE3_IN_OUT

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.

###### BLADE4_IN_OUT

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.

##### TSENS

###### BLADE1_TEMP1

Instance id: | FXE_OGT2_PSLIT/TSENS/BLADE1_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_PSLIT
Scenes: | OVERVIEW_OGT2_PSLIT, OVERVIEW_OGT2_PSLIT, FXE_OGT2_PSLIT/TSENS/BLADE1_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE1_TEMP2

Instance id: | FXE_OGT2_PSLIT/TSENS/BLADE1_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_PSLIT
Scenes: | FXE_OGT2_PSLIT/TSENS/BLADE1_TEMP2, OVERVIEW_OGT2_PSLIT, OVERVIEW_OGT2_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE2_TEMP1

Instance id: | FXE_OGT2_PSLIT/TSENS/BLADE2_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_PSLIT
Scenes: | FXE_OGT2_PSLIT/TSENS/BLADE2_TEMP1, OVERVIEW_OGT2_PSLIT, OVERVIEW_OGT2_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE2_TEMP2

Instance id: | FXE_OGT2_PSLIT/TSENS/BLADE2_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_PSLIT
Scenes: | FXE_OGT2_PSLIT/TSENS/BLADE2_TEMP2, OVERVIEW_OGT2_PSLIT, OVERVIEW_OGT2_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE3_TEMP1

Instance id: | FXE_OGT2_PSLIT/TSENS/BLADE3_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_PSLIT
Scenes: | FXE_OGT2_PSLIT/TSENS/BLADE3_TEMP1, OVERVIEW_OGT2_PSLIT, OVERVIEW_OGT2_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE3_TEMP2

Instance id: | FXE_OGT2_PSLIT/TSENS/BLADE3_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_PSLIT
Scenes: | FXE_OGT2_PSLIT/TSENS/BLADE3_TEMP2, OVERVIEW_OGT2_PSLIT, OVERVIEW_OGT2_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE4_TEMP1

Instance id: | FXE_OGT2_PSLIT/TSENS/BLADE4_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_PSLIT
Scenes: | OVERVIEW_OGT2_PSLIT, OVERVIEW_OGT2_PSLIT, FXE_OGT2_PSLIT/TSENS/BLADE4_TEMP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE4_TEMP2

Instance id: | FXE_OGT2_PSLIT/TSENS/BLADE4_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_PSLIT
Scenes: | FXE_OGT2_PSLIT/TSENS/BLADE4_TEMP2, OVERVIEW_OGT2_PSLIT, OVERVIEW_OGT2_PSLIT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### VAC

##### DCTRL

###### CRL_CC

Instance id: | FXE_OGT2_VAC/DCTRL/CRL_CC
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | VACUUM_OVERVIEW, VACUUM_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.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_CLOSEINPUTEXTERNAL

Instance id: | FXE_OGT2_VAC/DCTRL/FV_CLOSEINPUTEXTERNAL
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_CLOSEINPUTEXTERNAL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTCLOSE

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTCLOSE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTCLOSE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTEXTSIGNAL1

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTEXTSIGNAL1
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTEXTSIGNAL1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTEXTSIGNAL2

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTEXTSIGNAL2
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTEXTSIGNAL2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTINTERLOCKCLOSE

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTINTERLOCKCLOSE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTINTERLOCKCLOSE, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTINTERLOCKOPEN

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTINTERLOCKOPEN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTINTERLOCKOPEN, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTOPEN

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTOPEN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTOPEN, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTSENSOROFF1

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTSENSOROFF1
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTSENSOROFF1, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTSENSOROFF2

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTSENSOROFF2
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTSENSOROFF2, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_INPUTSYSTEMRESET

Instance id: | FXE_OGT2_VAC/DCTRL/FV_INPUTSYSTEMRESET
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/DCTRL/FV_INPUTSYSTEMRESET, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_OUTPUTCLOSE_state

Instance id: | FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state
Class id: | BeckhoffDigitalOutput
Host: | exflcon06n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT2_VAC
Scenes: | FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state, FXE_RR_SYS/ILOCK/MAIN|Global interlock (overview)
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### FV_OUTPUTOPEN_state

Instance id: | FXE_OGT2_VAC/DCTRL/FV_OUTPUTOPEN_state
Class id: | BeckhoffDigitalOutput
Host: | exflcon06n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### GV_OPEN

Instance id: | FXE_OGT2_VAC/DCTRL/GV_OPEN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INTERLOCK_ACTIV

Instance id: | FXE_OGT2_VAC/DCTRL/INTERLOCK_ACTIV
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INTERLOCK_BRIDGED

Instance id: | FXE_OGT2_VAC/DCTRL/INTERLOCK_BRIDGED
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_OUTPUTCLOSE_STATE

Instance id: | FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_STATE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_OUTPUTOPEN_STATE

Instance id: | FXE_OGT2_VAC/DCTRL/FV_OUTPUTOPEN_STATE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### CRL_CC

Instance id: | FXE_OGT2_VAC/GAUGE/CRL_CC
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT2_VAC/GAUGE/CRL_CC, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV, He-decon-GAUGES, VACUUM_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

###### DW_FR

Instance id: | FXE_OGT2_VAC/GAUGE/DW_FR
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC, FXE_OGT2_VAC, FXE_LOOP2
Scenes: | FXE_OGT2_VAC/GAUGE/DW_FR, VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT2_VAC/GAUGE/DW_FR, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV, He-decon-GAUGES, VACUUM_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

###### FV_ANAOUTPRESSURE1

Instance id: | FXE_OGT2_VAC/GAUGE/FV_ANAOUTPRESSURE1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/GAUGE/FV_ANAOUTPRESSURE1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FV_ANAOUTPRESSURE2

Instance id: | FXE_OGT2_VAC/GAUGE/FV_ANAOUTPRESSURE2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/GAUGE/FV_ANAOUTPRESSURE2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PSLIT2_FR

Instance id: | FXE_OGT2_VAC/GAUGE/PSLIT2_FR
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | VACUUM_OVERVIEW, FXE_OGT2_VAC/GAUGE/PSLIT2_FR, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV, He-decon-GAUGES, VACUUM_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

##### ICTRL

###### PUMP_CTL

Instance id: | FXE_OGT2_VAC/ICTRL/PUMP_CTL
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC, FXE_LOOP2, FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/ICTRL/PUMP_CTL150, FXE_OGT2_VAC/ICTRL/PUMP_CTL150, FXE_OGT2_VAC/ICTRL/PUMP_CTL, FXE_OGT2_VAC/ICTRL/PUMP_CTL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### PUMP_CTL150

Instance id: | FXE_OGT2_VAC/ICTRL/PUMP_CTL150
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC, FXE_LOOP2, FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/ICTRL/PUMP_CTL150, FXE_OGT2_VAC/ICTRL/PUMP_CTL150
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### CRL_IP55

Instance id: | FXE_OGT2_VAC/IPUMP/CRL_IP55
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC, FXE_OGT2_VAC, FXE_LOOP2
Scenes: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT2_VAC/IPUMP/CRL_IP55, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV, He-decon-IPUMPS, VACUUM_OVERVIEW, FXE_OGT2_VAC/IPUMP/CRL_IP55
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### DW_IP75

Instance id: | FXE_OGT2_VAC/IPUMP/DW_IP75
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC, FXE_LOOP2, FXE_OGT2_VAC
Scenes: | VACUUM_OVERVIEW, FXE_OGT2_VAC/IPUMP/DW_IP75, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV, FXE_OGT2_VAC/IPUMP/DW_IP75, He-decon-IPUMPS, VACUUM_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.
- 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

###### PSLIT2_IP150

Instance id: | FXE_OGT2_VAC/IPUMP/PSLIT2_IP150
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC, FXE_OGT2_VAC, FXE_LOOP2
Scenes: | VACUUM_OVERVIEW, FXE_OGT2_VAC/IPUMP/PSLIT2_IP150, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT2_VAC/IPUMP/PSLIT2_IP150, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV, He-decon-IPUMPS, VACUUM_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.
- 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

###### FV_CLOSEOUTPUTEXTERNAL

Instance id: | FXE_OGT2_VAC/SWITCH/FV_CLOSEOUTPUTEXTERNAL
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/SWITCH/FV_CLOSEOUTPUTEXTERNAL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTCLOSE

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FastValve, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTCLOSE_state_true

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE_state_true
Class id: | BeckhoffDigitalInput
Host: | exflcon07n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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: | FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- resetCounter:
    Reset count of edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.

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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### FV_OUTPUTINRUSH1

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSH1
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSH1, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTINRUSH2

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSH2
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSH2, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTINRUSHEXTSIGNAL1

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSHEXTSIGNAL1
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSHEXTSIGNAL1, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTINRUSHEXTSIGNAL2

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSHEXTSIGNAL2
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSHEXTSIGNAL2, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTOPEN

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTOPEN
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | VACUUM_OVERVIEW, INTERLOCK_SIGNALS, FXE_OGT2_VAC/SWITCH/FV_OUTPUTOPEN, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTOPEN_state

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTOPEN_state
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | INTERLOCK_SIGNALS, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTREADY

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY2, FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY, FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY1, FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTREADY1

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY1
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY1, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTREADY2

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY2
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY2, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTSYSTEM_READY

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTSYSTEM_READY
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | FXE_RR_SYS/ILOCK/MAIN|Global interlock, FXE_OGT2_VAC/SWITCH/FV_OUTPUTSYSTEM_READY, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state, FastValve
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### GV_OPEN

Instance id: | FXE_OGT2_VAC/SWITCH/GV_OPEN
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | INTERLOCK_SIGNALS, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### INTERLOCK_KEY_NC

Instance id: | FXE_OGT2_VAC/SWITCH/INTERLOCK_KEY_NC
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### INTERLOCK_KEY_NO

Instance id: | FXE_OGT2_VAC/SWITCH/INTERLOCK_KEY_NO
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### PRESSURE_SENSOR

Instance id: | FXE_OGT2_VAC/SWITCH/PRESSURE_SENSOR
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_OGT2_VAC
Scenes: | VACUUM_OVERVIEW, FXE_OGT2_VAC/SWITCH/PRESSURE_SENSOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### FV_OUTPUTCLOSE_STATE_TRUE

Instance id: | FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE_STATE_TRUE
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### COND_GV

Instance id: | FXE_OGT2_VAC/VALVE/COND_GV
Class id: | ConditionValve
Host: | fxe-rr-sys-con-2
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/conditionValve
Last modified: | 2020-11-24T12:43:17.000+01:00
Created at: | 2018-06-12T17:54:26.000+02:00
Main authors: | Hauf, Haufs, Degon
Latest tag: | 1.0.1-2.10.0
Deployment tag: | 1.0.1-2.10.0
Scenes: | VACUUM_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
- open:
    Open the valve without any conditions
- close:
    The software save slot close option

Release History
1.0.1-2.10.0

Created: | 2020-11-23T18:19:35.000+01:00
Author: | Steffen Hauf
Notes: |

1.0.1-2.2.4

Created: | 2018-09-19T15:11:26.000+02:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.4

Created: | 2018-06-18T17:41:52.000+02:00
Author: | Dennis Goeries
Notes: |

##### 3

Instance id: | FXE_OGT2_VAC/3
Class id: | BeckhoffAgilentIonPump
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

###### Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

#### VAC2

Instance id: | FXE_OGT2_VAC2
Host: | exflcon06n0
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
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.9-2.6.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

### OGT3

#### BIU

##### AVG

###### CAMERA

Instance id: | FXE_OGT3_BIU/AVG/CAMERA
Class id: | ImageAverager
Host: | exflcon67n0
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FXE_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### ENC

###### SCREEN_Y

Instance id: | FXE_OGT3_BIU/ENC/SCREEN_Y
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_BIU, FXE_OGT3_BIU
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MDL

###### MAIN

Instance id: | FXE_OGT3_BIU/MDL/MAIN
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-8
Alias: | fxe-rr-sys-con-8
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: | FXE_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!

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
- moveC_:
    Moves the motor to the position marked with this label
- moveYAG:
    Moves the motor to the position marked with this label
- moveC:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

###### SCREEN_Y

##### PROC

###### CAMERA

Instance id: | FXE_OGT3_BIU/PROC/CAMERA
Class id: | ImageProcessor
Host: | exflcon67n0
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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

###### ROD_TEMP1

Instance id: | FXE_OGT3_BIU/TSENS/ROD_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT3_BIU, FXE_OGT3_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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD_TEMP2

Instance id: | FXE_OGT3_BIU/TSENS/ROD_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT3_BIU, FXE_OGT3_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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD_TEMP3

Instance id: | FXE_OGT3_BIU/TSENS/ROD_TEMP3
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD_TEMP4

Instance id: | FXE_OGT3_BIU/TSENS/ROD_TEMP4
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT3_BIU/TSENS/SPARE1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_OGT3_BIU/TSENS/SPARE2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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]

###### LED

#### IPM

##### ENC

###### TARGET_IN_OUT

Instance id: | FXE_OGT3_IPM/ENC/TARGET_IN_OUT
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_IPM
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### TARGET_IN_OUT

###### AUX1

##### TSENS

###### TEMP1

Instance id: | FXE_OGT3_IPM/TSENS/TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT3_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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TEMP2

Instance id: | FXE_OGT3_IPM/TSENS/TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT3_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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TEMP3

Instance id: | FXE_OGT3_IPM/TSENS/TEMP3
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT3_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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TEMP4

Instance id: | FXE_OGT3_IPM/TSENS/TEMP4
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT3_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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

###### MONITOR

Instance id: | FXE_OGT3_IPM/MDL/MONITOR
Class id: | BeamPositionMonitor
Host: | fxe-rr-sys-con-4
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/beamPositionMonitor
Last modified: | 2021-04-13T23:18:59.000+02:00
Created at: | 2018-08-16T18:02:48.000+02:00
Main authors: | Haufs, Wajid, Cas
Latest tag: | 1.7.1-2.10.0
Deployment tag: | 1.7.1-2.10.0
Scenes: | IPM_2_overview, DIGI_APD_B2, IPM2_overview, FXE_DIGI_MAIN, FXE_OGT3_IPM/MDL/MONITOR, FXE_OGT3_IPM_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!

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
- topChannel:
    Please specify the ADC channel which correspond to Top
- bottomChannel:
    Please specify the ADC channel which correspond to Bottom
- leftChannel:
    Please specify the channel which correspond to Left
- rightChannel:
    Please specify the channel which correspond to Right
- calibrationFactorX:
    Calibration Factor to align beam position in x direction
- calibrationFactorY:
    Calibration Factor to align beam position in y direction
- fetchUpperBound:
    If true the value of upper bound will be computed from digitizer device and will be equal to number of pulses
- upperBound:
    upper range of window to select desired pulses
- lowerBound:
    Lower range of window to select desired pulses
- temporalAverage:
    Average is evaluated over N last Trains
- numberOfPulses:
    Number of pulses per train
- pulseThreshold:
    Threshold to validate the pulse
- trainThreshold:
    Threshold to validate the train
- pulseValidity:
    True, if a value of all channels at a given pulses are greater than pulse threshold otherwise false
- trainValidity:
    True, if pulseValidity of all channels are greater than train threshold otherwise false
- quadrant:
    Quadrant
- scatterPosition:
    Scatter Position Node

Release History
1.7.1-2.10.0

Created: | 2020-11-24T09:49:13.000+01:00
Author: | Wajid Ehsan
Notes: | Update version

1.7.0-2.9.0

Created: | 2020-11-03T15:33:31.000+01:00
Author: | Wajid Ehsan
Notes: | Get the value of the upper bound from the digitizer device.

1.6.0-2.7.0

Created: | 2020-05-04T12:55:53.000+02:00
Author: | Wajid Ehsan
Notes: | Scatter plot for standard deviation

1.5.0-2.7.0

Created: | 2020-03-26T11:11:17.000+01:00
Author: | Wajid Ehsan
Notes: | This device now gets data from digitizerData MDL device. which has different APD channels per board

1.4.1-2.4.0

Created: | 2019-06-07T16:31:10.000+02:00
Author: | Wajid Ehsan
Notes: | include Standard deviation

1.4.0-2.4.0-hotfix

Created: | 2019-06-03T18:11:25.000+02:00
Author: | CAS
Notes: | unset value will give exception

1.4.0-2.4.0

Created: | 2019-05-28T13:12:48.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of APD class

1.3.3-2.4.0

Created: | 2019-05-22T16:55:53.000+02:00
Author: | Wajid Ehsan
Notes: | Include Temporal Standard deviation

1.3.2-2.4.0

Created: | 2019-05-09T17:30:44.000+02:00
Author: | Wajid Ehsan
Notes: | Include Standard deviation

1.3.1-2.3.2

Created: | 2019-03-07T18:34:01.000+01:00
Author: | Wajid Ehsan
Notes: | Take absolute value of APD data for pulse validity

1.3.0-2.3.2

Created: | 2019-03-05T17:56:44.000+01:00
Author: | Wajid Ehsan
Notes: | Pulse and train validity check

1.2.0-2.3.2

Created: | 2019-02-15T17:04:14.000+01:00
Author: | Wajid Ehsan
Notes: | Separate channel for Digitizer APD data

1.1.0-2.2.4

Created: | 2018-12-20T12:31:16.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.1-2.2.4

Created: | 2018-09-17T20:38:32.000+02:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.4

Created: | 2018-09-10T10:17:12.000+02:00
Author: | Wajid Ehsan
Notes: | first version of Beam Position Monitor MDL device

###### MAIN

Instance id: | FXE_OGT3_IPM/MDL/MAIN
Class id: | BeamImagingUnit
Host: | fxe-rr-sys-con-8
Alias: | fxe-rr-sys-con-8
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: | FXE_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!

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
- moveC:
    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: |

#### MOV

##### MOTOR

###### X_1

###### X_2

###### Y_1

###### Y_2

###### Y_3

#### SA

##### CAM

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### ENC

###### AUX1

Instance id: | FXE_OGT3_SA/ENC/AUX1
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### AUX2

Instance id: | FXE_OGT3_SA/ENC/AUX2
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_THETA

Instance id: | FXE_OGT3_SA/ENC/CRYSTAL_THETA
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_X1

Instance id: | FXE_OGT3_SA/ENC/CRYSTAL_X1
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_X2

Instance id: | FXE_OGT3_SA/ENC/CRYSTAL_X2
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_Y

Instance id: | FXE_OGT3_SA/ENC/CRYSTAL_Y
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL_Z

Instance id: | FXE_OGT3_SA/ENC/CRYSTAL_Z
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### ROD_IN_OUT

Instance id: | FXE_OGT3_SA/ENC/ROD_IN_OUT
Host: | exflcon67n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.9-2.6.1
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### AUX1

###### AUX2

###### CRYSTAL_THETA

Instance id: | FXE_OGT3_SA/MOTOR/CRYSTAL_THETA
Class id: | BeckhoffMC2Base
Host: | exflcon67n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT3_SA
Scenes: | FXE_OGT3_SA/MOTOR/CRYSTAL_THETA|motorScene, FXE_OGT3_SA/MOTOR/CRYSTAL_THETA, FXE_OGT3_SA/MOTOR/CRYSTAL_THETA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### CRYSTAL_X1

Instance id: | FXE_OGT3_SA/MOTOR/CRYSTAL_X1
Class id: | BeckhoffMC2Base
Host: | exflcon67n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT3_SA
Scenes: | FXE_OGT3_SA/MOTOR/CRYSTAL_X1, FXE_OGT3_SA/MOTOR/CRYSTAL_X1|motorScene, FXE_OGT3_SA/MOTOR/CRYSTAL_X1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### CRYSTAL_X2

Instance id: | FXE_OGT3_SA/MOTOR/CRYSTAL_X2
Class id: | BeckhoffMC2Base
Host: | exflcon67n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT3_SA
Scenes: | FXE_OGT3_SA/MOTOR/CRYSTAL_X2|motorScene, FXE_OGT3_SA/MOTOR/CRYSTAL_X2, FXE_OGT3_SA/MOTOR/CRYSTAL_X2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### CRYSTAL_Y

Instance id: | FXE_OGT3_SA/MOTOR/CRYSTAL_Y
Class id: | BeckhoffMC2Base
Host: | exflcon67n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT3_SA
Scenes: | FXE_OGT3_SA/MOTOR/CRYSTAL_Y|motorScene, FXE_OGT3_SA/MOTOR/CRYSTAL_Y, FXE_OGT3_SA/MOTOR/CRYSTAL_Y
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### CRYSTAL_Z

Instance id: | FXE_OGT3_SA/MOTOR/CRYSTAL_Z
Class id: | BeckhoffMC2Base
Host: | exflcon67n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT3_SA
Scenes: | FXE_OGT3_SA/MOTOR/CRYSTAL_Z|motorScene, FXE_OGT3_SA/MOTOR/CRYSTAL_Z, FXE_OGT3_SA/MOTOR/CRYSTAL_Z
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### ROD_IN_OUT

Instance id: | FXE_OGT3_SA/MOTOR/ROD_IN_OUT
Class id: | BeckhoffMC2Base
Host: | exflcon67n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_OGT3_SA
Scenes: | FXE_OGT3_SA/MOTOR/ROD_IN_OUT|motorScene, FXE_OGT3_SA/MOTOR/ROD_IN_OUT, FXE_OGT3_SA/MOTOR/ROD_IN_OUT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### BASE_X

###### CRYST_THETA

###### CRYST_X

###### CRYST_Y

###### DET_THETA

###### DET_X

##### TSENS

###### ROD_TEMP1

Instance id: | FXE_OGT3_SA/TSENS/ROD_TEMP1
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT3_SA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD_TEMP2

Instance id: | FXE_OGT3_SA/TSENS/ROD_TEMP2
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_OGT3_SA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SA_TEMP

Instance id: | FXE_OGT3_SA/TSENS/SA_TEMP
Class id: | BeckhoffAnalogInput
Host: | exflcon67n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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
Projects: | FXE_OGT3_SA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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: |

##### CAL

[add component documentation]

###### CONTROL

Instance id: | FXE_OGT3_SA/CAL/CONTROL
Class id: | SlsCalibrator
Host: | fxe-rr-sys-con-8
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/slsCalibrator
Last modified: | 2021-08-06T08:25:04.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Parenti, Hauf, Danilevski
Latest tag: | 1.5.1-2.11.0
Deployment tag: | 1.5.1-2.11.0
Scenes: | FXE_OGT3_SA/DET/CONTROL, FXE_OGT3-SpA3_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!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- bkg:
    The background on ADC counts.
- cal:
    The calibration constants [keV/counts].
- averagedDisplay:
    Average all the frames in the train and then display.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.
- useBackgroundFrame:
    Use Frame for Background subtraction
- frameNumber:
    The index of the frame to be used for background subtraction
- errorCount:
    Number of errors.
- reset:
    Reset error count.

Release History
1.5.1-2.11.0

Created: | 2021-08-04T16:24:38.000+02:00
Author: | Alessandro Silenzi
Notes: | revert change in schema types.

1.5.0-2.11.0

Created: | 2021-07-26T17:39:35.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: output channel data matches the type in the schema. Schema changed properties VECTOR_FLOAT -> VECTOR_DOUBLE

1.4.1-2.10.0

Created: | 2020-11-24T12:14:02.000+01:00
Author: | Andrea Parenti
Notes: | Summary: added version info

1.4.0-2.5.1

Created: | 2019-08-08T15:22:44.000+02:00
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T14:31:43.000+02:00
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T12:01:40.000+02:00
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T13:58:56.000+01:00
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T10:34:30.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T14:50:05.000+01:00
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T11:28:08.000+01:00
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T18:29:31.000+02:00
Author: | Andrea Parenti
Notes: |

##### DET

[add component documentation]

###### CONTROL

Instance id: | FXE_OGT3_SA/DET/CONTROL
Class id: | GotthardControl
Host: | fxe-rr-sys-con-8
Class documentation:
| GotthardControl
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_OGT3_SA/DET/CONTROL, FXE_OGT3-SpA3_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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Starts acquisition
- stop:
    Stops acquisition
- reset:
    Resets the device in case of an error
- detectorHostName:
    Detector Host Name
- detectorIp:
    Detector IP. Must be on the same subnet as the receiver.
- detectorHostPort:
    Detector Host Port. Will use 1952 if left empty.
- detectorHostStopPort:
    Detector Host Stop Port. Will use 1953 if left empty.
- rxHostname:
    Receiver Hostname
- rxTcpPort:
    Receiver TCP Port
- rxUdpIp:
    Receiver UDP IP
- rxUdpPort:
    Receiver UDP Port
- settings:
    Settings
- online:
    Sets the detector in online (1) or offline (0) mode.
- angDir:
    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).
- moveFlag:
    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)
- lock:
    lock
- extSig0:
    Ext Sig 0
- vHighVoltageMax:
    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.
- vHighVoltage:
    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200
- master:
    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.
- sync:
    Sets the synchronization mode of the various controller within a detector structure
- badChannels:
    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.
- angConv:
    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.
- globalOff:
    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.
- binSize:
    Sets the size of the angular bins for angular conversion.
- threaded:
    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
- detectorDeveloper:
    Detector Developer. (useful to define subset of working functions)
- flatFieldCorrectionFile:
    Flat field corrections file name. Use ‘none’ to disable corrections.
- positions:
    Positions for the acquisition. Usage: n pos1 pos2 … posn
- maximumDetectorSize:
    Maximum detector size
- bitDepth:
    Bit Depth
- exposureTime:
    exposure time value
- exposurePeriod:
    exposure period
- delayAfterTrigger:
    delay after trigger
- numberOfGates:
    Number Of Gates
- numberOfFrames:
    Number Of Frames
- numberOfCycles:
    Number Of Cycles
- timing:
    The timing mode of the detector
- acquisitionTime:
    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.
- triggerPeriod:
    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.
- detectorNumber:
    Returns the serial number of the module (normally the MAC address).
- detectorVersion:
    Returns the version of the controller firmware.
- softwareVersion:
    Returns the version of the software running on the detector.
- thisVersion:
    Returns the version of the control software which is being used.
- pollingInterval:
    The interval for polling the laser front-end for status.
- tempAdc:
    Returns the ADC temperature.
- tempFpga:
    Returns the FPGA temperature.
- detectorMac:
    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.
- rOnline:
    rOnline

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

###### RECEIVER

Instance id: | FXE_OGT3_SA/DET/RECEIVER
Class id: | GotthardReceiver
Host: | fxe-rr-sys-con-8
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_OGT3_SA/DET/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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

#### IMG

[add component documentation]

##### CAM

[add component documentation]

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

#### VAC

[add component documentation]

##### GAUGE

[add component documentation]

###### SA2_FR

Instance id: | FXE_OGT3_VAC/GAUGE/SA2_FR
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

[add component documentation]

###### SP1

##### TPUMP

[add component documentation]

###### SA2

Instance id: | FXE_OGT3_VAC/TPUMP/SA2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

#### XGMD

[add component documentation]

##### ACTRL

[add component documentation]

###### LV1_FSETPOINT

Instance id: | FXE_OGT3_XGMD/ACTRL/LV1_FSETPOINT
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_PRESSURE

Instance id: | FXE_OGT3_XGMD/ACTRL/LV1_PRESSURE
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_PSETPOINT

Instance id: | FXE_OGT3_XGMD/ACTRL/LV1_PSETPOINT
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SPARE_PRESSURE

Instance id: | FXE_OGT3_XGMD/ACTRL/SPARE_PRESSURE
Class id: | BeckhoffAnalogOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
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.3-2.11.1
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.3-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

##### ASENS

[add component documentation]

###### LV1_PVALVE

Instance id: | FXE_OGT3_XGMD/ASENS/LV1_PVALVE
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LV1_RVOLTAGE

Instance id: | FXE_OGT3_XGMD/ASENS/LV1_RVOLTAGE
Class id: | BeckhoffAnalogInput
Host: | exflcon67n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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: |

###### LV1_VPOSITION

Instance id: | FXE_OGT3_XGMD/ASENS/LV1_VPOSITION
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LV1_VSIGNAL

Instance id: | FXE_OGT3_XGMD/ASENS/LV1_VSIGNAL
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### XIN_ION1_FC

Instance id: | FXE_OGT3_XGMD/ASENS/XIN_ION1_FC
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### XIN_ION2_FC

Instance id: | FXE_OGT3_XGMD/ASENS/XIN_ION2_FC
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LV1_FSETPOINT

Instance id: | FXE_OGT3_XGMD/ASENS/LV1_FSETPOINT
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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]

###### HV_LOCK

Instance id: | FXE_OGT3_XGMD/DCTRL/HV_LOCK
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LV1_FDECREASE

Instance id: | FXE_OGT3_XGMD/DCTRL/LV1_FDECREASE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LV1_FINCREASE

Instance id: | FXE_OGT3_XGMD/DCTRL/LV1_FINCREASE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LV1_FMODE

Instance id: | FXE_OGT3_XGMD/DCTRL/LV1_FMODE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LV1_PMODE

Instance id: | FXE_OGT3_XGMD/DCTRL/LV1_PMODE
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### XIN_AMP_GAIN

Instance id: | FXE_OGT3_XGMD/DCTRL/XIN_AMP_GAIN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### XP_AMP_GAIN

Instance id: | FXE_OGT3_XGMD/DCTRL/XP_AMP_GAIN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### GAUGE

[add component documentation]

###### P2_1READ

Instance id: | FXE_OGT3_XGMD/GAUGE/P2_1READ
Class id: | BeckhoffAnalogInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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]

###### LV1_EMISSIONON

Instance id: | FXE_OGT3_XGMD/SWITCH/LV1_EMISSIONON
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_ERROR

Instance id: | FXE_OGT3_XGMD/SWITCH/LV1_ERROR
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_LG

Instance id: | FXE_OGT3_XGMD/SWITCH/LV1_LG
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_LO

Instance id: | FXE_OGT3_XGMD/SWITCH/LV1_LO
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_POSITION

Instance id: | FXE_OGT3_XGMD/SWITCH/LV1_POSITION
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_READY

Instance id: | FXE_OGT3_XGMD/SWITCH/LV1_READY
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_SENERROR

Instance id: | FXE_OGT3_XGMD/SWITCH/LV1_SENERROR
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### LV1_SENSTATUS

Instance id: | FXE_OGT3_XGMD/SWITCH/LV1_SENSTATUS
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

##### DOOCS

[add component documentation]

###### MAIN

##### PUMP

[add component documentation]

###### XGMSP

##### TPUMP

[add component documentation]

###### XGMTP

Instance id: | FXE_OGT3_XGMD/TPUMP/XGMTP
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

#### PAM

[add component documentation]

##### CAL

[add component documentation]

###### CONTROL_REF

Instance id: | FXE_OGT3_PAM/CAL/CONTROL_REF
Class id: | SlsCalibrator
Host: | fxe-rr-sys-con-2
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/slsCalibrator
Last modified: | 2021-08-06T08:25:04.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Parenti, Hauf, Danilevski
Latest tag: | 1.5.1-2.11.0
Deployment tag: | 1.5.1-2.11.0
Scenes: | FXE_OGT3_PAM/DET/CONTROL_REF
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!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- bkg:
    The background on ADC counts.
- cal:
    The calibration constants [keV/counts].
- averagedDisplay:
    Average all the frames in the train and then display.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.
- useBackgroundFrame:
    Use Frame for Background subtraction
- frameNumber:
    The index of the frame to be used for background subtraction
- errorCount:
    Number of errors.
- reset:
    Reset error count.

Release History
1.5.1-2.11.0

Created: | 2021-08-04T16:24:38.000+02:00
Author: | Alessandro Silenzi
Notes: | revert change in schema types.

1.5.0-2.11.0

Created: | 2021-07-26T17:39:35.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: output channel data matches the type in the schema. Schema changed properties VECTOR_FLOAT -> VECTOR_DOUBLE

1.4.1-2.10.0

Created: | 2020-11-24T12:14:02.000+01:00
Author: | Andrea Parenti
Notes: | Summary: added version info

1.4.0-2.5.1

Created: | 2019-08-08T15:22:44.000+02:00
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T14:31:43.000+02:00
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T12:01:40.000+02:00
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T13:58:56.000+01:00
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T10:34:30.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T14:50:05.000+01:00
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T11:28:08.000+01:00
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T18:29:31.000+02:00
Author: | Andrea Parenti
Notes: |

##### DCTRL

[add component documentation]

###### SAMPLE_CAM

Instance id: | FXE_OGT3_PAM/DCTRL/SAMPLE_CAM
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### DET

[add component documentation]

###### CONTROL_SIG

Instance id: | FXE_OGT3_PAM/DET/CONTROL_SIG
Class id: | GotthardControl
Host: | fxe-rr-sys-con-gotthard
Class documentation:
| GotthardControl
Alias: | fxe-rr-sys-con-gotthard
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_OGT3_PAM/DET/CONTROL_SIG
Accessible by: | CAL, CONTROLS, CTRL, DA, ardanaf, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Starts acquisition
- stop:
    Stops acquisition
- reset:
    Resets the device in case of an error
- detectorHostName:
    Detector Host Name
- detectorIp:
    Detector IP. Must be on the same subnet as the receiver.
- detectorHostPort:
    Detector Host Port. Will use 1952 if left empty.
- detectorHostStopPort:
    Detector Host Stop Port. Will use 1953 if left empty.
- rxHostname:
    Receiver Hostname
- rxTcpPort:
    Receiver TCP Port
- rxUdpIp:
    Receiver UDP IP
- rxUdpPort:
    Receiver UDP Port
- settings:
    Settings
- online:
    Sets the detector in online (1) or offline (0) mode.
- angDir:
    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).
- moveFlag:
    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)
- lock:
    lock
- extSig0:
    Ext Sig 0
- vHighVoltageMax:
    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.
- vHighVoltage:
    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200
- master:
    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.
- sync:
    Sets the synchronization mode of the various controller within a detector structure
- badChannels:
    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.
- angConv:
    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.
- globalOff:
    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.
- binSize:
    Sets the size of the angular bins for angular conversion.
- threaded:
    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
- detectorDeveloper:
    Detector Developer. (useful to define subset of working functions)
- flatFieldCorrectionFile:
    Flat field corrections file name. Use ‘none’ to disable corrections.
- positions:
    Positions for the acquisition. Usage: n pos1 pos2 … posn
- maximumDetectorSize:
    Maximum detector size
- bitDepth:
    Bit Depth
- exposureTime:
    exposure time value
- exposurePeriod:
    exposure period
- delayAfterTrigger:
    delay after trigger
- numberOfGates:
    Number Of Gates
- numberOfFrames:
    Number Of Frames
- numberOfCycles:
    Number Of Cycles
- timing:
    The timing mode of the detector
- acquisitionTime:
    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.
- triggerPeriod:
    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.
- detectorNumber:
    Returns the serial number of the module (normally the MAC address).
- detectorVersion:
    Returns the version of the controller firmware.
- softwareVersion:
    Returns the version of the software running on the detector.
- thisVersion:
    Returns the version of the control software which is being used.
- pollingInterval:
    The interval for polling the laser front-end for status.
- tempAdc:
    Returns the ADC temperature.
- tempFpga:
    Returns the FPGA temperature.
- detectorMac:
    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.
- rOnline:
    rOnline

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

###### RECEIVER_REF

Instance id: | FXE_OGT3_PAM/DET/RECEIVER_REF
Class id: | GotthardReceiver
Host: | fxe-rr-sys-con-2
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_OGT3_PAM/DET/CONTROL_REF
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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

###### RECEIVER_SIG

Instance id: | FXE_OGT3_PAM/DET/RECEIVER_SIG
Class id: | GotthardReceiver
Host: | fxe-rr-sys-con-gotthard
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-gotthard
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_OGT3_PAM/DET/CONTROL_SIG
Accessible by: | CAL, CONTROLS, CTRL, DA, ardanaf, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

##### MOTOR

[add component documentation]

###### DELAY

###### INCOUPLING1_X

###### INCOUPLING1_Y

###### INCOUPLING2_X

###### INCOUPLING2_Y

###### SAMPLE1_ROT

###### SAMPLE1_X

###### SAMPLE1_Y

###### SAMPLE1_Z

Instance id: | FXE_OGT3_PAM/MOTOR/SAMPLE1_Z
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SAMPLE2_ROT

###### SAMPLE2_X

###### SAMPLE2_Y

###### SAMPLE2_Z

###### SPECT_GRATING

##### PMOTOR

[add component documentation]

###### INCOUPLING_H_SPEC

Instance id: | FXE_OGT3_PAM/PMOTOR/INCOUPLING_H_SPEC
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### INCOUPLING_V_SPEC

Instance id: | FXE_OGT3_PAM/PMOTOR/INCOUPLING_V_SPEC
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### MIRROR_DOWN_1

Instance id: | FXE_OGT3_PAM/PMOTOR/MIRROR_DOWN_1
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### MIRROR_DOWN_2

Instance id: | FXE_OGT3_PAM/PMOTOR/MIRROR_DOWN_2
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### MIRROR_UP_1

Instance id: | FXE_OGT3_PAM/PMOTOR/MIRROR_UP_1
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### MIRROR_UP_2

Instance id: | FXE_OGT3_PAM/PMOTOR/MIRROR_UP_2
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUTCOUPLING_H_SPEC

Instance id: | FXE_OGT3_PAM/PMOTOR/OUTCOUPLING_H_SPEC
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUTCOUPLING_V_SPEC

Instance id: | FXE_OGT3_PAM/PMOTOR/OUTCOUPLING_V_SPEC
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

### RR

#### DAQ

##### ADC

###### 1

Instance id: | FXE_RR_DAQ/ADC/1
Class id: | AdqDigitizer
Host: | fxe-rr-sys-utc-2
Class documentation:
| AdqDigitizer
Alias: | fxe-rr-sys-utc-2-mch , exflutcafxe-2
Git repo: | https://git.xfel.eu/karaboDevices/adqDigitizer
Last modified: | 2021-05-18T17:33:08.000+02:00
Created at: | 2017-05-09T17:54:27.000+02:00
Main authors: | Hauf, Fabbri, Haufs
Latest tag: | 4.4.4-2.10.0
Deployment tag: | 4.4.4-2.10.0
Installed tag: | 4.4.4-2.10.0
Scenes: | FXE-ADQ-GENERAL, FXE_DIGITIZER_UTC2-CONTROL, test_Scene_BPM, FXE-ADQ-RAW, FXE-ADQ-APD-1, BunchPattern, BeamPositionMonitor, IPM2_overview, DigitizerGraph, IPM_overview, FXE_RR_DAQ/ADC/1, Graph, XRAY_PULSE_ENERGY_MONITOR, XRAY_PULSE_ENERGY_MONITOR, Graph, test_Scene, IPM2_overview, test_fastAdc, DIGI_APD_mode_overview, FXE_OGT1_IPM/MDL/MONITOR, FXE_DIGI_MAIN, Digitizer_Simple, Digitizer_Advance, test
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

ADQ Digitizer

The `AdqDigitizer` device is documented in adqdigitizer:welcome

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Starts data acquisition.
- stop:
    Stops data acquisition.
- swtrigger:
    Sends a software trigger to the hardware (always possible, independent of chosen trigger mode).
- reset:
    Resets the device by reconnecting the hardware.
- adqapiRevision:
    SP DEVICES software revision
- daqDependent:
    If enabled the device will go to disengaged state when number of samples are changed, to remind users that now the cycling of DAQ is required to include schema related changes. To move back to ON State please execute slot’Acknowledge Changes’
- acknowledgeChanges:
    This slot is just to remind users that they have changed few properties which now requires cycling of DAQ to include schema related changes. On Acknowledging this slot this device will go back to ON state
- trainIdSource:
    Select source of train ID
- acquireCount:
    Number of triggers to process in one run (0 denotes an infinite run, which needs to be stopped explicitely).
- acquisitionTime:
    Acquisition time. Closely connected to ‘acquireCount’ (Triggers per Run): 1 sec == 10 triggers. 0 means forever. This parameter has a precedency over acquireCount.
- lengthOfBufferPool:
    Length of the pool of output Hashes for sending to DAQ. Run will be stopped if we use all entries.
- boardsTimeShift:
    The time shift between two consecutive boards in milliseconds while sending raw data from FPGA
- sizeFilledBuffers:
    Size of filled buffers queue. Normal to be 0. Max value is buffer pool size
- dumpEnable:
    If enabled the binary stream data will be stored without parsing as is
- dumpfile:
    File name of dumped RAW data for selected Board/Channel. Extension ‘.bin’ means binary otherwise text format

Release History
4.4.4-2.10.0

Created: | 2021-05-11T12:48:09.000+02:00
Author: | Wajid Ehsan
Notes: | Avoid concurrent writes to the output channel

4.4.3-2.10.0

Created: | 2021-04-28T22:44:21.000+02:00
Author: | Sergey Esenov
Notes: | Fix board configurations

4.4.2-2.10.0

Created: | 2021-04-12T17:06:38.000+02:00
Author: | Wajid Ehsan
Notes: | Interim solution added to remind users that now cycling of DAQ is required to include schema related changes.

4.4.0-2.10.0

Created: | 2021-02-23T15:12:05.000+01:00
Author: | Wajid Ehsan
Notes: | Tag for ADQ412. Firmware 021-002-006-A or 021-002-006-B required. For potential support for ADQ7 and ADQ14.

4.3.1-2.10.0

Created: | 2020-11-30T10:43:54.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.12-2.10.0

Created: | 2020-11-24T17:33:21.000+01:00
Author: | Wajid Ehsan
Notes: | Tag to be used for old versions of the firmware which does not have the changing sample number issue

4.3.0-2.9.1-hotfix-2

Created: | 2020-09-07T14:05:12.000+02:00
Author: | Robert Schaffer
Notes: | Added “None” option for trigger output

4.3.0-2.9.1-hotfix

Created: | 2020-08-31T09:05:31.000+02:00
Author: | Robert Schaffer
Notes: | Removed zero suppression from the schema to eliminate issues with the DAQ

4.1.10-2.3.4-fix

Created: | 2020-08-12T16:10:52.000+02:00
Author: | Robert Schaffer
Notes: | Similar fix for older digitizer firmware version

4.1.11-2.3.4-fix

Created: | 2020-08-12T14:35:04.000+02:00
Author: | Robert Schaffer
Notes: | Tag to be used for old versions of the firmware which does not have the changing sample number issue

4.3.0-2.9.1

Created: | 2020-07-29T14:35:44.000+02:00
Author: | Sergey Esenov
Notes: | Support for ADQ7, ADQ14 and fixed bug in ADQ412. Firmware 021-002-006-A required.

4.1.10-2.10.0-fix

Created: | 2020-07-29T14:35:44.000+02:00
Author: | Sergey Esenov
Notes: |

4.2.1-2.8.0

Created: | 2020-05-07T16:14:35.000+02:00
Author: | Sergey Esenov
Notes: | Updates and fixes to allow specific PES setup: high frequecy trigger rate, trigger signal on front panel,…

4.2.0-2.7.0

Created: | 2020-02-21T17:20:57.000+01:00
Author: | Sergey Esenov
Notes: | Requires ADQ412-3G/4G firmware “021-002-006-A” and not backward compatible with older firmware versions. Experimental support for ADQ7. No support yet for ADQ14.

4.1.11-2.3.4

Created: | 2019-05-10T14:45:45.000+02:00
Author: | Sergey Esenov
Notes: | This version requires the firmware ‘021-002-005-C’. Check the used firmware with AE group.

4.1.10-2.3.4

Created: | 2019-04-01T18:51:21.000+02:00
Author: | Sergey Esenov
Notes: | Fix bug in initialization of NDArray in digitizer and use NDArrays by default.

4.1.9-2.3.4

Created: | 2019-03-21T11:30:39.000+01:00
Author: | Sergey Esenov
Notes: | Fix calculation of number of pulses, improve error reporting and actions when stopping the run

4.1.8-2.3.4

Created: | 2019-03-05T16:54:26.000+01:00
Author: | Sergey Esenov
Notes: | Bug fixing release: misinterpreted index, recovery trigger settings after the crash.

4.1.7-2.3.4

Created: | 2019-02-25T14:17:36.000+01:00
Author: | Sergey Esenov
Notes: | Fix race condition and SEGFAULT.

4.1.6-2.3.4

Created: | 2019-02-19T16:09:13.000+01:00
Author: | Sergey Esenov
Notes: | Attempt to fix SIGSEGV by avoid operations with invalid iterator. Introduce parameter that limits the time range where zero suppression and peak detection algorithms work.

#### SYS

##### CORRELATION

###### JF_MOTOR

Instance id: | FXE_RR_SYS/CORRELATION/JF_MOTOR
Class id: | DataCorrelator
Host: | exflonc04
Alias: | sa1-br-kc-comp-4 , la1-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/DataCorrelator
Last modified: | 2020-11-20T20:07:25.000+01:00
Created at: | 2019-01-22T14:50:17.000+01:00
Main authors: | Kamil, Hauf
Latest tag: | 0.1.2-2.7.0
Deployment tag: | 0.1.2-2.7.0
Scenes: | CORRELATOR_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- buffer:
    Buffer size for uncorrelated trains.
- detectorId:
    Detector device ID
- detectorProperty:
    Detector Property
- start:
    Acquire data and process
- reset:
    Clear history

Release History
0.1.2-2.7.0

Created: | 2020-06-03T08:50:19.000Z
Author: | Ebad Kamil
Notes: | Use of registerChannelMonitor with the device client.

0.1.1-2.4.0

Created: | 2019-05-07T07:51:05.000Z
Author: | Ebad Kamil
Notes: | Fixed crash of device due to interfering thread Locks.

0.1.0-2.4.0

Created: | 2019-05-02T07:30:03.000Z
Author: | Ebad Kamil
Notes: |

###### LPD1M1_MOTOR

Instance id: | FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR
Class id: | DataCorrelator
Host: | exflonc04
Alias: | la1-br-kc-comp-4 , sa1-br-kc-comp-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/DataCorrelator
Last modified: | 2020-06-03T10:47:51.000+02:00
Created at: | 2019-01-22T14:50:17.000+01:00
Main authors: | Kamil, Hauf
Latest tag: | 0.1.2-2.7.0
Deployment tag: | 0.1.2-2.7.0
Scenes: | CORRELATOR_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- buffer:
    Buffer size for uncorrelated trains.
- detectorId:
    Detector device ID
- detectorProperty:
    Detector Property
- start:
    Acquire data and process
- reset:
    Clear history

Release History
0.1.2-2.7.0

Created: | 2020-06-03T08:50:19.000Z
Author: | Ebad Kamil
Notes: | Use of registerChannelMonitor with the device client.

0.1.1-2.4.0

Created: | 2019-05-07T07:51:05.000Z
Author: | Ebad Kamil
Notes: | Fixed crash of device due to interfering thread Locks.

0.1.0-2.4.0

Created: | 2019-05-02T07:30:03.000Z
Author: | Ebad Kamil
Notes: |

##### MON

###### PLC_1

Instance id: | FXE_RR_SYS/MON/PLC_1
Host: | exflcon07n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2019-05-28T11:30:33.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Scenes: | FXE_RR_SYS/MON/PLC_1|Control, FXE_RR_SYS/MON/PLC_1|Export PLC params
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PLC_2

Instance id: | FXE_RR_SYS/MON/PLC_2
Host: | exflcon06n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2019-05-28T11:30:33.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Scenes: | FXE_RR_SYS/MON/PLC_2|Control
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PLC_3

Instance id: | FXE_RR_SYS/MON/PLC_3
Host: | exflcon09n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2019-05-28T11:30:33.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Scenes: | FXE_RR_SYS/MON/PLC_3|Control
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PLC_4

Instance id: | FXE_RR_SYS/MON/PLC_4
Host: | exflcon11n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2019-05-28T11:30:33.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Scenes: | FXE_RR_SYS/MON/PLC_4|Control
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PLC_5

Instance id: | FXE_RR_SYS/MON/PLC_5
Host: | exflcon12n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2019-05-28T11:30:33.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Scenes: | FXE_RR_SYS/MON/PLC_5|Control
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PLC_7

Instance id: | FXE_RR_SYS/MON/PLC_7
Host: | exflcon17n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2019-05-28T11:30:33.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Scenes: | FXE_RR_SYS/MON/PLC_7|Control
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PLC_8

Instance id: | FXE_RR_SYS/MON/PLC_8
Host: | exflcon67n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2019-05-28T11:30:33.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Scenes: | FXE_RR_SYS/MON/PLC_8|Control
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PLC_9

Instance id: | FXE_RR_SYS/MON/PLC_9
Host: | exflcon51n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2019-05-28T11:30:33.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Scenes: | FXE_RR_SYS/MON/PLC_9|Control
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PLC_12

Instance id: | FXE_RR_SYS/MON/PLC_12
Host: | exflcon54n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/BeckhoffMonitor
Last modified: | 2020-03-20T10:04:23.000+01:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.4-2.4.2
Deployment tag: | 1.1.4-2.4.2
Installed tag: | 1.1.4-2.4.2
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
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: |

##### PLC

###### 1

Instance id: | FXE_RR_SYS/PLC/1
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_LOOP1, AMAIN_copy, FXE_LOOP1
Scenes: | VACUUM_OVERVIEW, VACUUM_OVERVIEW, FXE_BECKHOFF_OVERVIEW, 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

###### 1_PLCMON

Instance id: | FXE_RR_SYS/PLC/1_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | 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

###### 2

Instance id: | FXE_RR_SYS/PLC/2
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_LOOP2, AMAIN_copy, FXE_LOOP2
Scenes: | VACUUM_OVERVIEW, VACUUM_OVERVIEW, FXE_BECKHOFF_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
- 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

###### 2_PLCMON

Instance id: | FXE_RR_SYS/PLC/2_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 3

Instance id: | FXE_RR_SYS/PLC/3
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-3
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | FXE_LOOP3, AMAIN_copy
Scenes: | FXE_BECKHOFF_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
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 3_PLCMON

Instance id: | FXE_RR_SYS/PLC/3_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 4

Instance id: | FXE_RR_SYS/PLC/4
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-4
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_LOOP4, AMAIN_copy
Scenes: | FXE_BECKHOFF_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
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 4_PLCMON

Instance id: | FXE_RR_SYS/PLC/4_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-4
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 5

Instance id: | FXE_RR_SYS/PLC/5
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-5
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_LOOP5, AMAIN_copy
Scenes: | FXE_BECKHOFF_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
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 5_PLCMON

Instance id: | FXE_RR_SYS/PLC/5_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-5
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 7

Instance id: | FXE_RR_SYS/PLC/7
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-7
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_LOOP7, AMAIN_copy
Scenes: | FXE_BECKHOFF_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
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 7_PLCMON

Instance id: | FXE_RR_SYS/PLC/7_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-7
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 8

Instance id: | FXE_RR_SYS/PLC/8
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-8
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_LOOP8, AMAIN_copy, FXE_LOOP8
Scenes: | FXE_BECKHOFF_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
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 8_PLCMON

Instance id: | FXE_RR_SYS/PLC/8_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-8
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 9

Instance id: | FXE_RR_SYS/PLC/9
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-9
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_LOOP9, AMAIN_copy
Scenes: | FXE_BECKHOFF_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
- 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

###### 9_PLCMON

Instance id: | FXE_RR_SYS/PLC/9_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-9
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### PRI

Instance id: | FXE_RR_SYS/PLC/PRI
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_RR_SYS
Scenes: | FXE_BECKHOFF_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
- 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

###### PRI_PLCMON

Instance id: | FXE_RR_SYS/PLC/PRI_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 6

Instance id: | FXE_RR_SYS/PLC/6
Class id: | BeckhoffCom
Host: | fxe-rr-sys-con-6
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_BECKHOFF_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
- 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
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### 6_PLCMON

Instance id: | FXE_RR_SYS/PLC/6_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- 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

##### TSYS

###### UTC-1-S2

Instance id: | FXE_RR_SYS/TSYS/UTC-1-S2
Class id: | X2Timer
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.14-2.11.1) does not match tags mentioned in the deployment ([‘1.8.16-2.11.1’])!

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- 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
- 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

###### UTC-1-S3

Instance id: | FXE_RR_SYS/TSYS/UTC-1-S3
Class id: | X2Timer
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Scenes: | Veto Config, test_scene, Veto Config (Duplicate MON_1, WIP), Veto Config (Duplicate MON_1)
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.14-2.11.1) does not match tags mentioned in the deployment ([‘1.8.16-2.11.1’])!

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- 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
- 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

###### UTC-2-S2

Instance id: | FXE_RR_SYS/TSYS/UTC-2-S2
Class id: | X2Timer
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.14-2.11.1) does not match tags mentioned in the deployment ([‘1.8.16-2.11.1’])!

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- 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
- 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

###### UTC-2-S3

Instance id: | FXE_RR_SYS/TSYS/UTC-2-S3
Class id: | X2Timer
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.14-2.11.1) does not match tags mentioned in the deployment ([‘1.8.16-2.11.1’])!

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- 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
- 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

##### TVIEW

###### EXP_SCOPE

Instance id: | FXE_RR_SYS/TVIEW/EXP_SCOPE
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.2.4-2.6.4
Installed tag: | 1.2.6-2.6.4
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

Warning

The installed tag (1.2.6-2.6.4) does not match tags mentioned in the deployment ([‘1.2.4-2.6.4’])!

[add instance documentation]

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.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### GOTTHARD

Instance id: | FXE_RR_SYS/TVIEW/GOTTHARD
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### LPD

Instance id: | FXE_RR_SYS/TVIEW/LPD
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | test_scene, TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT1_BIU

Instance id: | FXE_RR_SYS/TVIEW/OGT1_BIU
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT1_SA

Instance id: | FXE_RR_SYS/TVIEW/OGT1_SA
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.2.4-2.6.4
Installed tag: | 1.2.6-2.6.4
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

Warning

The installed tag (1.2.6-2.6.4) does not match tags mentioned in the deployment ([‘1.2.4-2.6.4’])!

[add instance documentation]

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.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### OGT1_TAD

Instance id: | FXE_RR_SYS/TVIEW/OGT1_TAD
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT2_BIU-1

Instance id: | FXE_RR_SYS/TVIEW/OGT2_BIU-1
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT2_BIU-2

Instance id: | FXE_RR_SYS/TVIEW/OGT2_BIU-2
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT3_BIU

Instance id: | FXE_RR_SYS/TVIEW/OGT3_BIU
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT3_SA

Instance id: | FXE_RR_SYS/TVIEW/OGT3_SA
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.2.4-2.6.4
Installed tag: | 1.2.6-2.6.4
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

Warning

The installed tag (1.2.6-2.6.4) does not match tags mentioned in the deployment ([‘1.2.4-2.6.4’])!

[add instance documentation]

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.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### PNCCD

Instance id: | FXE_RR_SYS/TVIEW/PNCCD
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.2.4-2.6.4
Installed tag: | 1.2.6-2.6.4
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

Warning

The installed tag (1.2.6-2.6.4) does not match tags mentioned in the deployment ([‘1.2.4-2.6.4’])!

[add instance documentation]

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.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### TANGERINE

Instance id: | FXE_RR_SYS/TVIEW/TANGERINE
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.2.4-2.6.4
Installed tag: | 1.2.6-2.6.4
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

Warning

The installed tag (1.2.6-2.6.4) does not match tags mentioned in the deployment ([‘1.2.4-2.6.4’])!

[add instance documentation]

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.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### TEST_TRIGGER

Instance id: | FXE_RR_SYS/TVIEW/TEST_TRIGGER
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed 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!

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: |

###### USER_1

Instance id: | FXE_RR_SYS/TVIEW/USER_1
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.2.4-2.6.4
Installed tag: | 1.2.6-2.6.4
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

Warning

The installed tag (1.2.6-2.6.4) does not match tags mentioned in the deployment ([‘1.2.4-2.6.4’])!

[add instance documentation]

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.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### USER_2

Instance id: | FXE_RR_SYS/TVIEW/USER_2
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.2.4-2.6.4
Installed tag: | 1.2.6-2.6.4
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

Warning

The installed tag (1.2.6-2.6.4) does not match tags mentioned in the deployment ([‘1.2.4-2.6.4’])!

[add instance documentation]

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.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### USER_3

Instance id: | FXE_RR_SYS/TVIEW/USER_3
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.2.4-2.6.4
Installed tag: | 1.2.6-2.6.4
Accessible by: | CONTROLS, DA

Warning

Device is installed in development mode!

Warning

The installed tag (1.2.6-2.6.4) does not match tags mentioned in the deployment ([‘1.2.4-2.6.4’])!

[add instance documentation]

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.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### AUXT_SCOPE

Instance id: | FXE_RR_SYS/TVIEW/AUXT_SCOPE
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### ILH_TRG1

Instance id: | FXE_RR_SYS/TVIEW/ILH_TRG1
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### ILH_TRG2

Instance id: | FXE_RR_SYS/TVIEW/ILH_TRG2
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### ILH_TRG3

Instance id: | FXE_RR_SYS/TVIEW/ILH_TRG3
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### LAS_CHOP

Instance id: | FXE_RR_SYS/TVIEW/LAS_CHOP
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### LAS_SHUT

Instance id: | FXE_RR_SYS/TVIEW/LAS_SHUT
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### LAS_USR

Instance id: | FXE_RR_SYS/TVIEW/LAS_USR
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT1_SA_CAM

Instance id: | FXE_RR_SYS/TVIEW/OGT1_SA_CAM
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT1_SA_GOTTHARD

Instance id: | FXE_RR_SYS/TVIEW/OGT1_SA_GOTTHARD
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT3_SA_CAM

Instance id: | FXE_RR_SYS/TVIEW/OGT3_SA_CAM
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT3_SA_GOTTHARD

Instance id: | FXE_RR_SYS/TVIEW/OGT3_SA_GOTTHARD
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### SMS_CAM

Instance id: | FXE_RR_SYS/TVIEW/SMS_CAM
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### SMS_JF1M

Instance id: | FXE_RR_SYS/TVIEW/SMS_JF1M
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### UT1

Instance id: | FXE_RR_SYS/TVIEW/UT1
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### UT2

Instance id: | FXE_RR_SYS/TVIEW/UT2
Class id: | X2TimerML
Host: | exflcon13n0
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-03-16T10:51:59.000+01:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Ehsan, Hickin
Latest tag: | 1.3.2-2.7.0
Deployment tag: | 1.3.2-2.7.0
Scenes: | TimingMain
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- invertTrigger:
    Invert the trigger signal.
- setControl:
    Set the control value
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.18

Created: | 2017-10-05T17:34:26.000Z
Author: | Dennis Goeries
Notes: |

###### UT3

Instance id: | FXE_RR_SYS/TVIEW/UT3
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### DIGITIZER_1

Instance id: | FXE_RR_SYS/TVIEW/DIGITIZER_1
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT3_BIU4

Instance id: | FXE_RR_SYS/TVIEW/OGT3_BIU4
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### GOTTHARD_GATE

Instance id: | FXE_RR_SYS/TVIEW/GOTTHARD_GATE
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT1_SA_GOTTHARD_GATE

Instance id: | FXE_RR_SYS/TVIEW/OGT1_SA_GOTTHARD_GATE
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### OGT3_SA_GOTTHARD_GATE

Instance id: | FXE_RR_SYS/TVIEW/OGT3_SA_GOTTHARD_GATE
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 1.4.1-2.11.0
Scenes: | TimingMain
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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: |

###### ILH_TRG3_GATE

Instance id: | FXE_RR_SYS/TVIEW/ILH_TRG3_GATE
Class id: | X2TimerML
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed 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!

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: |

##### ZMQ

###### JF_MOTOR

Instance id: | FXE_RR_SYS/ZMQ/JF_MOTOR
Class id: | PipeToZeroMQ
Host: | exflonc04
Alias: | sa1-br-kc-comp-4 , la1-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
Scenes: | CORRELATOR_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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: |

###### LPD1M1_MOTOR

Instance id: | FXE_RR_SYS/ZMQ/LPD1M1_MOTOR
Class id: | PipeToZeroMQ
Host: | exflonc04
Alias: | la1-br-kc-comp-4 , sa1-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
Scenes: | CORRELATOR_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- 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: |

##### MDL

[add component documentation]

###### APD_CFG

###### APD_DATA

##### DOOCS

[add component documentation]

###### REQUESTOR

#### MPOD-1

[add component documentation]

##### MCPS

[add component documentation]

###### MPOD

Instance id: | FXE_RR_MPOD-1/MCPS/MPOD
Class id: | Mpod
Host: | fxe-rr-sys-con-14
Class documentation:
| Mpod
Alias: | fxe-rr-sys-con-14
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: | FXE_RR_MPOD-1/MCPS/MPOD|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!

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: |

### SMS

#### APD

##### MDL

###### I0

Instance id: | FXE_SMS_APD/MDL/I0
Host: | exflcon20n0
Alias: | testdaq-rr-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamPositionMonitor
Last modified: | 2020-03-16T12:21:15.000+01:00
Created at: | 2018-08-16T18:02:48.000+02:00
Main authors: | Cas, Ehsan
Latest tag: | 1.4.1-2.4.0
Deployment tag: | 1.4.1-2.4.0
Installed tag: | 1.4.1-2.4.0
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

[add instance documentation]

Release History
1.4.1-2.4.0

Created: | 2019-06-07T14:31:10.000Z
Author: | Wajid Ehsan
Notes: | include Standard deviation

1.4.0-2.4.0-hotfix

Created: | 2019-06-03T16:11:25.000Z
Author: | CAS
Notes: | unset value will give exception

1.4.0-2.4.0

Created: | 2019-05-28T11:12:48.000Z
Author: | Wajid Ehsan
Notes: | Integration of APD class

1.3.3-2.4.0

Created: | 2019-05-22T14:55:53.000Z
Author: | Wajid Ehsan
Notes: | Include Temporal Standard deviation

1.3.2-2.4.0

Created: | 2019-05-09T15:30:44.000Z
Author: | Wajid Ehsan
Notes: | Include Standard deviation

1.3.1-2.3.2

Created: | 2019-03-07T17:34:01.000Z
Author: | Wajid Ehsan
Notes: | Take absolute value of APD data for pulse validity

1.3.0-2.3.2

Created: | 2019-03-05T16:56:44.000Z
Author: | Wajid Ehsan
Notes: | Pulse and train validity check

1.2.0-2.3.2

Created: | 2019-02-15T16:04:14.000Z
Author: | Wajid Ehsan
Notes: | Separate channel for Digitizer APD data

1.1.0-2.2.4

Created: | 2018-12-20T11:31:16.000Z
Author: | Wajid Ehsan
Notes: |

1.0.1-2.2.4

Created: | 2018-09-17T18:38:32.000Z
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.4

Created: | 2018-09-10T08:17:12.000Z
Author: | Wajid Ehsan
Notes: | first version of Beam Position Monitor MDL device

#### JSS

##### ENC

###### CRYSTAL1_DISTANCE

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL1_DISTANCE
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL1_THETA

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL1_THETA
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL1_Y

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL1_Y
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL1_YAW

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL1_YAW
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL2_DISTANCE

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL2_DISTANCE
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL2_THETA

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL2_THETA
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL2_Y

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL2_Y
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL2_YAW

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL2_YAW
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL3_DISTANCE

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL3_DISTANCE
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL3_THETA

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL3_THETA
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL3_Y

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL3_Y
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL3_YAW

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL3_YAW
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL4_DISTANCE

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL4_DISTANCE
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL4_THETA

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL4_THETA
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL4_Y

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL4_Y
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL4_YAW

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL4_YAW
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL5_DISTANCE

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL5_DISTANCE
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL5_THETA

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL5_THETA
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL5_Y

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL5_Y
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### CRYSTAL5_YAW

Instance id: | FXE_SMS_JSS/ENC/CRYSTAL5_YAW
Host: | exflcon12n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-5
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.9-2.6.1
Projects: | FXE_SMS_JSS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### CRYSTAL1_DISTANCE

###### CRYSTAL1_THETA

###### CRYSTAL1_Y

###### CRYSTAL1_YAW

###### CRYSTAL2_DISTANCE

###### CRYSTAL2_THETA

###### CRYSTAL2_Y

###### CRYSTAL2_YAW

###### CRYSTAL3_DISTANCE

###### CRYSTAL3_THETA

###### CRYSTAL3_Y

###### CRYSTAL3_YAW

###### CRYSTAL4_DISTANCE

###### CRYSTAL4_THETA

###### CRYSTAL4_Y

###### CRYSTAL4_YAW

###### CRYSTAL5_DISTANCE

###### CRYSTAL5_THETA

###### CRYSTAL5_Y

###### CRYSTAL5_YAW

##### MDL

[add component documentation]

###### CRYSTAL1

###### CRYSTAL2

###### CRYSTAL3

###### CRYSTAL4

###### CRYSTAL5

###### CRYSTAL_GROUP

#### MOV

##### ENC

###### 2THETA_HIGH

Instance id: | FXE_SMS_MOV/ENC/2THETA_HIGH
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_SMS_MOV, FXE_SMS_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### 2THETA_LOW

Instance id: | FXE_SMS_MOV/ENC/2THETA_LOW
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_SMS_MOV, FXE_SMS_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### PITCH

Instance id: | FXE_SMS_MOV/ENC/PITCH
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_SMS_MOV, FXE_SMS_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### ROLL

Instance id: | FXE_SMS_MOV/ENC/ROLL
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_SMS_MOV, FXE_SMS_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### Y

Instance id: | FXE_SMS_MOV/ENC/Y
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_SMS_MOV, FXE_SMS_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### YAW

Instance id: | FXE_SMS_MOV/ENC/YAW
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_SMS_MOV, FXE_SMS_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### Z_HIGH

Instance id: | FXE_SMS_MOV/ENC/Z_HIGH
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_SMS_MOV, FXE_SMS_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### Z_LOW

Instance id: | FXE_SMS_MOV/ENC/Z_LOW
Host: | exflcon11n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-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.9-2.6.1
Projects: | FXE_SMS_MOV, FXE_SMS_MOV
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### 2THETA_HIGH

###### 2THETA_LOW

###### PITCH

###### ROLL

###### Y

###### YAW

###### Z_HIGH

Instance id: | FXE_SMS_MOV/MOTOR/Z_HIGH
Class id: | BeckhoffMC2Base
Host: | exflcon11n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_SMS_MOV
Scenes: | FXE_SMS_MOV/MOTOR/Z_HIGH, FXE_SMS_OVERVIEW, FXE_SMS_MOV/MOTOR/Z_HIGH|motorScene, GI_Diffraction, FXE_SMS_MOV-MOTOR-Z_HIGH, GI_Diffraction, GI_Diffraction, GI_Diffraction, GI_Diffraction, Custom_Motors-3, FXE_SMS_MOV-MOTOR-Z_HIGH
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### Z_LOW

Instance id: | FXE_SMS_MOV/MOTOR/Z_LOW
Class id: | BeckhoffMC2Base
Host: | exflcon11n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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
Projects: | FXE_SMS_MOV
Scenes: | FXE_SMS_MOV/MOTOR/Z_LOW, FXE_SMS_OVERVIEW, FXE_SMS_MOV/MOTOR/Z_LOW|motorScene, FXE_SMS_MOV-MOTOR-Z_LOW, GI_Diffraction, FXE_SMS_MOV-MOTOR-Z_LOW, GI_Diffraction, GI_Diffraction, GI_Diffraction, GI_Diffraction
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.
- 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.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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### X_LOW

###### YLOW

###### Y_HIGH

##### SMSCAM

###### AVG

Instance id: | FXE_SMS_MOV/SMSCAM/AVG
Class id: | ImageAverager
Host: | exflcon17n0
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### PROC

Instance id: | FXE_SMS_MOV/SMSCAM/PROC
Class id: | ImageProcessor
Host: | exflcon17n0
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.

##### SMSMIC

###### AVG

Instance id: | FXE_SMS_MOV/SMSMIC/AVG
Class id: | ImageAverager
Host: | exflcon17n0
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FXE_SMS_MIC, FXE_SMS_MIC_ALT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### PROC

Instance id: | FXE_SMS_MOV/SMSMIC/PROC
Class id: | ImageProcessor
Host: | exflcon17n0
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FXE_SMS_MIC, FXE_SMS_MIC_ALT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SMSXEY

###### AVG

Instance id: | FXE_SMS_MOV/SMSXEY/AVG
Class id: | ImageAverager
Host: | exflcon17n0
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FXE_XEY, FXE_XEY_caustic, FXE_XEY_caustic
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### PROC

Instance id: | FXE_SMS_MOV/SMSXEY/PROC
Class id: | ImageProcessor
Host: | exflcon17n0
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FXE_XEY, FXE_XEY_caustic, FXE_XEY_caustic
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

#### USR

##### ENC

###### UE01

Instance id: | FXE_SMS_USR/ENC/UE01
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE02

Instance id: | FXE_SMS_USR/ENC/UE02
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE03

Instance id: | FXE_SMS_USR/ENC/UE03
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE04

Instance id: | FXE_SMS_USR/ENC/UE04
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE05

Instance id: | FXE_SMS_USR/ENC/UE05
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE06

Instance id: | FXE_SMS_USR/ENC/UE06
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE07

Instance id: | FXE_SMS_USR/ENC/UE07
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE08

Instance id: | FXE_SMS_USR/ENC/UE08
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE09

Instance id: | FXE_SMS_USR/ENC/UE09
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE10

Instance id: | FXE_SMS_USR/ENC/UE10
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE11

Instance id: | FXE_SMS_USR/ENC/UE11
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE12SC

Instance id: | FXE_SMS_USR/ENC/UE12SC
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE13SC

Instance id: | FXE_SMS_USR/ENC/UE13SC
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE14SC

Instance id: | FXE_SMS_USR/ENC/UE14SC
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE15SC

Instance id: | FXE_SMS_USR/ENC/UE15SC
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE16

Instance id: | FXE_SMS_USR/ENC/UE16
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE17

Instance id: | FXE_SMS_USR/ENC/UE17
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE18

Instance id: | FXE_SMS_USR/ENC/UE18
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE19V5

Instance id: | FXE_SMS_USR/ENC/UE19V5
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### UE20V5

Instance id: | FXE_SMS_USR/ENC/UE20V5
Host: | exflcon51n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-9
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.9-2.6.1
Projects: | FXE_SMS_USR, FXE_SMS_USR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### UM01

###### UM02

###### UM03

###### UM04

###### UM05

###### UM06

###### UM07

###### UM08

###### UM09

###### UM10

###### UM11

###### UM12

###### UM13

###### UM14

###### UM15

###### UM16

###### UM17

###### UM18

###### UM19

###### UM20

#### VHS

##### DAQ

###### DETECTOR

Instance id: | FXE_SMS_VHS/DAQ/DETECTOR
Class id: | GotthardReceiver
Host: | exflcon17n0
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-08-05T15:05:54.000+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Xctrl, Silenzi
Latest tag: | 1.8.0-2.9.1
Deployment tag: | 1.8.0-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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.

Release History
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.

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

##### ENC

###### VHS_LATERAL

Instance id: | FXE_SMS_VHS/ENC/VHS_LATERAL
Host: | exflcon17n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
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.9-2.6.1
Projects: | FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### VHS_ROLL

Instance id: | FXE_SMS_VHS/ENC/VHS_ROLL
Host: | exflcon17n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
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.9-2.6.1
Projects: | FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### VHS_SAGITTAL

Instance id: | FXE_SMS_VHS/ENC/VHS_SAGITTAL
Host: | exflcon17n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
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.9-2.6.1
Projects: | FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### VHS_TILT

Instance id: | FXE_SMS_VHS/ENC/VHS_TILT
Host: | exflcon17n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
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.9-2.6.1
Projects: | FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### VHS_Y

Instance id: | FXE_SMS_VHS/ENC/VHS_Y
Host: | exflcon17n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
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.9-2.6.1
Projects: | FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### VHS_YAW

Instance id: | FXE_SMS_VHS/ENC/VHS_YAW
Host: | exflcon17n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-7
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.9-2.6.1
Projects: | FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS, FXE_SMS_VHS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

##### MOTOR

###### CR01_M1

###### CR01_M2

###### CR01_M3

###### CR02_M4

###### CR02_M5

###### CR02_M6

###### CR03_M1

###### CR03_M2

###### CR03_M3

###### CR04_M4

###### CR04_M5

###### CR04_M6

###### CR05_M1

###### CR05_M2

###### CR05_M3

###### CR06_M4

###### CR06_M5

###### CR06_M6

###### CR07_M1

###### CR07_M2

###### CR07_M3

###### CR08_M4

###### CR08_M5

###### CR08_M6

###### CR09_M1

###### CR09_M2

###### CR09_M3

###### CR10_M4

###### CR10_M5

###### CR10_M6

###### CR11_M1

###### CR11_M2

###### CR11_M3

###### CR12_M4

###### CR12_M5

###### CR12_M6

###### CR13_M1

###### CR13_M2

###### CR13_M3

###### CR14_M4

###### CR14_M5

###### CR14_M6

###### CR15_M1

###### CR15_M2

###### CR15_M3

###### CR16_M4

###### CR16_M5

###### CR16_M6

###### VHS_LATERAL

###### VHS_ROLL

###### VHS_SAGITTAL

###### VHS_TILT

###### VHS_Y

###### VHS_YAW

### SYS

#### VAC2MPS

##### DCTRL

###### FXE_1_VALVES_OPEN

Instance id: | FXE_SYS_VAC2MPS/DCTRL/FXE_1_VALVES_OPEN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-11 , fxe-rr-sys-con-13 , fxe-rr-sys-con-14 , fxe-rr-sys-con-1 , fxe-rr-sys-con-10
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.3-2.11.1
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.3-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs 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.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

###### FXE_2_VALVES_OPEN

Instance id: | FXE_SYS_VAC2MPS/DCTRL/FXE_2_VALVES_OPEN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-2
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.3-2.11.1
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.3-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs 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.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

###### FXE_VALVES_OPEN

Instance id: | FXE_SYS_VAC2MPS/DCTRL/FXE_VALVES_OPEN
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODE1_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODE1_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

### TO

#### MPS

##### DCTRL

###### BEAM_MODE1

Instance id: | FXE_TO_MPS/DCTRL/BEAM_MODE1
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_TO_MPS_DCTRL_BEAM_MODES_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODE1_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODE1_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODES_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BEAM_MODEF

Instance id: | FXE_TO_MPS/DCTRL/BEAM_MODEF
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_TO_MPS_DCTRL_BEAM_MODEF_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODEF_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BEAM_MODEM

Instance id: | FXE_TO_MPS/DCTRL/BEAM_MODEM
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_TO_MPS_DCTRL_BEAM_MODEF_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODEF_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODEM_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODEM_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BEAM_MODES

Instance id: | FXE_TO_MPS/DCTRL/BEAM_MODES
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_TO_MPS_DCTRL_BEAM_MODES_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODEM_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODEM_INTERLOCK, FXE_TO_MPS_DCTRL_BEAM_MODES_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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_CLOSE_2B

Instance id: | FXE_TO_MPS/DCTRL/SHUT_CLOSE_2B
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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_CLOSE_4A

Instance id: | FXE_TO_MPS/DCTRL/SHUT_CLOSE_4A
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### ABS_CLOSED

Instance id: | FXE_TO_MPS/SWITCH/ABS_CLOSED
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | INTERLOCK_SIGNALS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

### XAD

#### GEC

##### MDL

###### ROI_SPECTRUM

Instance id: | FXE_XAD_GEC/MDL/ROI_SPECTRUM
Class id: | ImageNormRoi
Host: | exflcon19n0
Alias: | fxe-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Projects: | GREATEYES
Scenes: | SPECTRUM_NORM
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Norm ROI

The `ImageNormRoi` device is part of the imageProcessor package, and is documented in imageprocessor:image-norm-roi-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
- frameRate:
    Rate of processed images.
- roiSize:
    The user-defined region of interest (ROI), specified as [width_roi, height_roi].
- dataRoiPosition:
    The user-defined position of the data ROI of the image [x, y]. Coordinates are taken top-left!
- normRoiPosition:
    The user-defined position of the ROI to normalize the image [x, y]. Coordinates are taken top-left!
- spectrumIntegral:
    Integral of the spectrum, after applying ROI.
- 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.

#### JF1M

##### CAL

###### APPEND

Instance id: | FXE_XAD_JF1M/CAL/APPEND
Class id: | CppFemCombiner
Host: | sa1-br-sys-cal-5
Alias: | sa1-br-sys-cal-5
Git repo: | https://git.xfel.eu/karaboDevices/cppFemCombiner
Last modified: | 2021-06-03T15:24:45.000+02:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Hauf, Ahmed
Latest tag: | 1.4.4-2.10.0
Deployment tag: | 1.4.4-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | JF1M
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0’])!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.4-2.10.0

Created: | 2021-01-06T14:15:58.000+01:00
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T16:28:15.000+01:00
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T12:13:39.000+02:00
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T19:11:45.000+02:00
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T12:50:55.000+02:00
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T14:25:56.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T16:27:25.000+02:00
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T17:35:08.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T12:00:10.000+01:00
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T10:21:54.000+02:00
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T11:46:52.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T19:17:42.000+02:00
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T10:17:59.000+02:00
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T13:29:04.000+02:00
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T13:52:33.000+01:00
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T09:37:12.000+01:00
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T14:06:13.000+01:00
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T10:20:08.000+02:00
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T10:44:38.000+02:00
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T08:13:23.000+02:00
Author: | Steffen Hauf
Notes: |

###### COMBINE

Instance id: | FXE_XAD_JF1M/CAL/COMBINE
Class id: | FemDataAssembler
Host: | sa1-br-sys-cal-5
Alias: | sa1-br-sys-cal-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2021-06-11T17:29:11.000+02:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Danilevski, Haufs, Santos
Latest tag: | 1.4.1-2.10.0
Deployment tag: | 1.4.1-2.10.0
Installed tag: | 1.3.0-2.4.1
Scenes: | test, JF1M, JF1M-New-Feedback
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.0-2.4.1) does not match tags mentioned in the deployment ([‘1.4.1-2.10.0’])!

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
- output:
    Output channel for combined data
- transposeDims:
    Transpose dimensions of data input array

Release History
1.4.1-2.10.0

Created: | 2021-01-06T13:19:56.000Z
Author: | Cyril Danilevski
Notes: | Karabo 2.10 compatibility

1.4.0-2.10.0-test

Created: | 2020-11-24T16:18:58.000Z
Author: | haufs
Notes: |

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: |

###### CORR_GAIN-1

Instance id: | FXE_XAD_JF1M/CAL/CORR_GAIN-1
Class id: | RelativeGainCorrectionJungfrau
Host: | exflong05
Alias: | spb-br-sys-cal-5 , sa1-br-sys-cal-5
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: | JF1M-new, JF1M, JF1M, Inprogress
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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_GAIN-2

Instance id: | FXE_XAD_JF1M/CAL/CORR_GAIN-2
Class id: | RelativeGainCorrectionJungfrau
Host: | exflong05
Alias: | spb-br-sys-cal-5 , sa1-br-sys-cal-5
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: | JF1M-new, JF1M, JF1M, Inprogress
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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-1

Instance id: | FXE_XAD_JF1M/CAL/CORR_OFFSET-1
Class id: | OffsetCorrectionJungfrau
Host: | exflong05
Alias: | spb-br-sys-cal-5 , sa1-br-sys-cal-5
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: | JF1M-new, JF1M, JF1M, Inprogress
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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-2

Instance id: | FXE_XAD_JF1M/CAL/CORR_OFFSET-2
Class id: | OffsetCorrectionJungfrau
Host: | exflong05
Alias: | spb-br-sys-cal-5 , sa1-br-sys-cal-5
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: | JF1M-new, JF1M, JF1M, Inprogress
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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: | FXE_XAD_JF1M/CAL/MANAGER
Class id: | CalManager
Host: | sa1-br-sys-cal-5
Alias: | sa1-br-sys-cal-5
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: | jungfrau_multi_mem_cell
Scenes: | JF1M-new, JF1M, JF1M, JF1M-New-Feedback, JF1M-Simple0
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

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, 0:00:00!

Warning

The installed tag (jungfrau_multi_mem_cell) 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: | FXE_XAD_JF1M/DET/CONTROL
Class id: | JungfrauControl
Host: | fxe-rr-sys-con-jungf
Class documentation:
| JungfrauControl
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | JF1M-new, JF1M, JF1M, JF1M-New-Feedback, JF1M-Simple0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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
- 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!
- exposureTimeout:
    In burst acquisition mode, the time interval between two consecutive exposures can be tuned with this timeout. Note that the time interval between consecutive exposures is also determined by the operation of the ASIC control FSM, as well as by the pre-charger and DS timeouts. The exposure timeout t_{ET} increases the range of the timeout betweeen two consecutive storage cells.
- exposureTimer:
    This value is obtained from the exposure timeout as: ET = t_ET / 25 ns - 1.

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

###### RECEIVER-1

Instance id: | FXE_XAD_JF1M/DET/RECEIVER-1
Host: | exflcon190
Class documentation:
| JungfrauReceiver
Alias: | fxe-rr-sys-con-jungf
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: | JF1M, JF1M-new, JF1M, test
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

[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

###### RECEIVER-2

Instance id: | FXE_XAD_JF1M/DET/RECEIVER-2
Host: | exflcon190
Class documentation:
| JungfrauReceiver
Alias: | fxe-rr-sys-con-jungf
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: | JF1M, JF1M-new, JF1M
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

[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

###### JNGFR01

Instance id: | FXE_XAD_JF1M/DET/JNGFR01
Class id: | JungfrauReceiver
Host: | fxe-rr-sys-con-jungf
Class documentation:
| JungfrauReceiver
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | JF1M, JF1M-New-Feedback, JF1M-Simple0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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
- 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.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

###### JNGFR02

Instance id: | FXE_XAD_JF1M/DET/JNGFR02
Class id: | JungfrauReceiver
Host: | fxe-rr-sys-con-jungf
Class documentation:
| JungfrauReceiver
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | JF1M, JF1M-New-Feedback, JF1M-Simple0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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
- 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.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

###### DARK

Instance id: | FXE_XAD_JF1M/MDL/DARK
Class id: | JungfrauDarkChar
Host: | fxe-rr-sys-con-jungf
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/JungfrauMiddlelayer
Last modified: | 2021-08-26T09:20:42.499+02:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Mamchykd, Parenti, Hauf
Latest tag: | 1.2.3-2.11.1
Deployment tag: | 1.2.3-2.11.1
Scenes: | 1M_CONFIG_DARK, JF1M
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, 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
- numberOfCycles:
    Number of trains (or soft triggers)
- useNewImplementation:
    Check to use the new implementation using the DAQ Controller
- storageCellStart:
    Starting storage cell for burst mode acquisitions.

Release History
1.2.3-2.11.1

Created: | 2021-07-18T14:44:36.000+02:00
Author: | mamchykd
Notes: | Summary: update daqController to 1.4.6-2.11.1

1.2.2-2.10.0

Created: | 2020-12-02T10:16:46.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update daqController to 1.4.4-2.10.0

1.2.1-2.10.0

Created: | 2020-11-23T14:10:42.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.2.0-2.8.0

Created: | 2020-11-19T14:24:50.000+01:00
Author: | Istvan Mohacsi
Notes: | Summary: New dark procedure for burst mode acquisitions. Installation: DaqController dependency added to dependencies. Devices: No change in devices. Schema: Yes, schema changed to add new functionality.

1.2.0-2.8.0-newprocedure

Created: | 2020-07-21T19:14:42.000+02:00
Author: | Istvan Mohacsi
Notes: | Preparing the dark characterization device

1.2.0-2.8.0-test

Created: | 2020-04-14T10:50:05.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.1.8-2.6.1

Created: | 2019-12-17T16:52:43.000+01:00
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T09:18:27.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T14:26:07.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T14:27:35.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T14:22:50.000+01:00
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T16:02:41.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T10:53:07.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T10:29:22.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T15:26:52.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T11:43:32.000+02:00
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T10:33:46.000+02:00
Author: | Steffen Hauf
Notes: |

###### CONFIG

Instance id: | FXE_XAD_JF1M/MDL/CONFIG
Class id: | JungfrauConfig
Host: | fxe-rr-sys-con-jungf
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/JungfrauMiddlelayer
Last modified: | 2021-08-26T09:20:42.499+02:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Mamchykd, Parenti, Hauf
Latest tag: | 1.2.3-2.11.1
Deployment tag: | 1.2.3-2.11.1
Scenes: | 1M_CONFIG_DARK, JF1M
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, 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
- 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.3-2.11.1

Created: | 2021-07-18T14:44:36.000+02:00
Author: | mamchykd
Notes: | Summary: update daqController to 1.4.6-2.11.1

1.2.2-2.10.0

Created: | 2020-12-02T10:16:46.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update daqController to 1.4.4-2.10.0

1.2.1-2.10.0

Created: | 2020-11-23T14:10:42.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.2.0-2.8.0

Created: | 2020-11-19T14:24:50.000+01:00
Author: | Istvan Mohacsi
Notes: | Summary: New dark procedure for burst mode acquisitions. Installation: DaqController dependency added to dependencies. Devices: No change in devices. Schema: Yes, schema changed to add new functionality.

1.2.0-2.8.0-newprocedure

Created: | 2020-07-21T19:14:42.000+02:00
Author: | Istvan Mohacsi
Notes: | Preparing the dark characterization device

1.2.0-2.8.0-test

Created: | 2020-04-14T10:50:05.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.1.8-2.6.1

Created: | 2019-12-17T16:52:43.000+01:00
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T09:18:27.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T14:26:07.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T14:27:35.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T14:22:50.000+01:00
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T16:02:41.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T10:53:07.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T10:29:22.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T15:26:52.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T11:43:32.000+02:00
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T10:33:46.000+02:00
Author: | Steffen Hauf
Notes: |

###### CAL_SYNC_CHECK

##### ZMQ

[add component documentation]

###### APPEND

Instance id: | FXE_XAD_JF1M/ZMQ/APPEND
Class id: | PipeToZeroMQ
Host: | sa1-br-kc-comp-3
Alias: | sa1-br-kc-comp-3
Git repo: | https://git.xfel.eu/karaboDevices/PipeToZeroMQ
Last modified: | 2021-08-05T13:42:03.000+02:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Haufs, Dall’antonia, Michelat
Latest tag: | 3.2.6-2.11.0
Deployment tag: | 3.2.6-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, 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
- 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.6-2.11.0

Created: | 2021-08-05T13:41:59.000+02:00
Author: | Thomas Michelat
Notes: | Schema update compatible with karabo 2.11

3.2.5-2.11.0hotfix1

Created: | 2021-07-20T11:35:08.000+02:00
Author: | Riccardo Fabbri
Notes: |

3.2.5-2.10.0

Created: | 2020-11-26T13:52:59.000+01:00
Author: | Thomas Michelat
Notes: | Add Karabo 2.10 Versioning Info

3.2.4-2.10.0

Created: | 2020-11-18T11:03:59.000+01:00
Author: | Thomas Michelat
Notes: | Karabo 2.10 compatibility: now validate the schema of tables.

3.2.3-2.9.0

Created: | 2020-11-05T18:59:22.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.2.2-2.9.0

Created: | 2020-11-05T17:23:38.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.2.1-2.9.0

Created: | 2020-11-05T12:23:45.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.1.1-2.9.0

Created: | 2020-06-03T10:31:31.000+02:00
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

3.0.1-2.7.1

Created: | 2020-03-09T17:39:08.000+01:00
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-17T19:11:31.000+01:00
Author: | Thomas Michelat
Notes: |

2.5.3-2.6.4

Created: | 2019-11-21T13:49:39.000+01:00
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T15:07:41.000+02:00
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T15:24:28.000+02:00
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T13:22:48.000+02:00
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T17:15:49.000+02:00
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T14:24:56.000+01:00
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-06T16:04:31.000+01:00
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T17:29:01.000+02:00
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-14T18:48:15.000+02:00
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-05T18:55:54.000+02:00
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

#### JF500K

##### CAL

###### MANAGER

Instance id: | FXE_XAD_JF500K/CAL/MANAGER
Class id: | CalManager
Host: | sa1-br-sys-cal-5
Alias: | sa1-br-sys-cal-5
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: | jungfrau_multi_mem_cell
Scenes: | JF500K
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

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, 0:00:00!

Warning

The installed tag (jungfrau_multi_mem_cell) 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: | FXE_XAD_JF500K/CAL/CORR_GAIN
Class id: | RelativeGainCorrectionJungfrau
Host: | sa1-br-sys-cal-5
Alias: | sa1-br-sys-cal-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2021-06-25T16:47:02.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Danilevski
Latest tag: | 2.1.1-2.10.0
Deployment tag: | 2.1.1-2.10.0
Installed tag: | jungfrau_multi_mem_cell
Scenes: | JF500K
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

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, 0:00:00!

Warning

The installed tag (jungfrau_multi_mem_cell) does not match tags mentioned in the deployment ([‘2.1.1-2.10.0’])!

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- det_type:
    Name of the detector type as registered in iCalibrationDB
- det_identifier:
    Name of the karabo detector identifier for the operating detector
- da_name:
    Name of the data aggregator that is registered in the calibration database and used to name raw data files
- 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
2.1.1-2.10.0

Created: | 2021-06-10T16:11:48.000Z
Author: | Cyril Danilevski
Notes: | Same as 2.1.0-2.10.0

2.1.0-2.10.0

Created: | 2021-06-10T16:11:48.000Z
Author: | Cyril Danilevski
Notes: | Remove CalibrationProducer based devices.

2.0.0-2.10.0

Created: | 2021-05-21T12:45:50.000Z
Author: | Cyril Danilevski
Notes: | Implement new LPD constants.

1.20.1-2.10.0

Created: | 2021-04-20T09:55:13.000Z
Author: | Cyril Danilevski
Notes: | Update depends files to upgrade calibrationBase

1.20.0-2.10.0

Created: | 2021-04-19T17:28:38.000Z
Author: | Cyril Danilevski
Notes: | Add Module Matcher device

1.19.1-2.10.0

Created: | 2021-04-06T11:17:50.000Z
Author: | Karim Ahmed
Notes: |

1.19.0-2.10.0

Created: | 2021-03-29T17:00:21.000Z
Author: | Karim Ahmed
Notes: | AGIPD fixed gain tag

1.19.0-2.10.0-test

Created: | 2021-03-22T06:54:42.000Z
Author: | Karim Ahmed
Notes: |

1.18.1-2.10.0

Created: | 2021-02-26T18:57:26.000Z
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-26T18:57:26.000Z
Author: | Karim Ahmed
Notes: |

1.18.0-2.10.0

Created: | 2021-02-24T14:50:01.000Z
Author: | Cyril Danilevski
Notes: |

1.18.0-2.10.0-test

Created: | 2021-02-23T12:22:22.000Z
Author: | Karim Ahmed
Notes: | New CalCat Mapping

1.17.0-2.10.0

Created: | 2021-01-15T13:29:51.000Z
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.000Z
Author: | haufs
Notes: |

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

###### CORR_OFFSET

Instance id: | FXE_XAD_JF500K/CAL/CORR_OFFSET
Class id: | OffsetCorrectionJungfrau
Host: | sa1-br-sys-cal-5
Alias: | sa1-br-sys-cal-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2021-06-25T16:47:02.000+02:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Danilevski
Latest tag: | 2.1.1-2.10.0
Deployment tag: | 2.1.1-2.10.0
Installed tag: | jungfrau_multi_mem_cell
Scenes: | JF500K
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

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, 0:00:00!

Warning

The installed tag (jungfrau_multi_mem_cell) does not match tags mentioned in the deployment ([‘2.1.1-2.10.0’])!

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
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- det_type:
    Name of the detector type as registered in iCalibrationDB
- det_identifier:
    Name of the karabo detector identifier for the operating detector
- da_name:
    Name of the data aggregator that is registered in the calibration database and used to name raw data files
- 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
2.1.1-2.10.0

Created: | 2021-06-10T16:11:48.000Z
Author: | Cyril Danilevski
Notes: | Same as 2.1.0-2.10.0

2.1.0-2.10.0

Created: | 2021-06-10T16:11:48.000Z
Author: | Cyril Danilevski
Notes: | Remove CalibrationProducer based devices.

2.0.0-2.10.0

Created: | 2021-05-21T12:45:50.000Z
Author: | Cyril Danilevski
Notes: | Implement new LPD constants.

1.20.1-2.10.0

Created: | 2021-04-20T09:55:13.000Z
Author: | Cyril Danilevski
Notes: | Update depends files to upgrade calibrationBase

1.20.0-2.10.0

Created: | 2021-04-19T17:28:38.000Z
Author: | Cyril Danilevski
Notes: | Add Module Matcher device

1.19.1-2.10.0

Created: | 2021-04-06T11:17:50.000Z
Author: | Karim Ahmed
Notes: |

1.19.0-2.10.0

Created: | 2021-03-29T17:00:21.000Z
Author: | Karim Ahmed
Notes: | AGIPD fixed gain tag

1.19.0-2.10.0-test

Created: | 2021-03-22T06:54:42.000Z
Author: | Karim Ahmed
Notes: |

1.18.1-2.10.0

Created: | 2021-02-26T18:57:26.000Z
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-26T18:57:26.000Z
Author: | Karim Ahmed
Notes: |

1.18.0-2.10.0

Created: | 2021-02-24T14:50:01.000Z
Author: | Cyril Danilevski
Notes: |

1.18.0-2.10.0-test

Created: | 2021-02-23T12:22:22.000Z
Author: | Karim Ahmed
Notes: | New CalCat Mapping

1.17.0-2.10.0

Created: | 2021-01-15T13:29:51.000Z
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.000Z
Author: | haufs
Notes: |

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

##### DET

###### CONTROL

Instance id: | FXE_XAD_JF500K/DET/CONTROL
Class id: | JungfrauControl
Host: | fxe-rr-sys-con-jungf
Class documentation:
| JungfrauControl
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | JF500K
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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
- 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!
- exposureTimeout:
    In burst acquisition mode, the time interval between two consecutive exposures can be tuned with this timeout. Note that the time interval between consecutive exposures is also determined by the operation of the ASIC control FSM, as well as by the pre-charger and DS timeouts. The exposure timeout t_{ET} increases the range of the timeout betweeen two consecutive storage cells.
- exposureTimer:
    This value is obtained from the exposure timeout as: ET = t_ET / 25 ns - 1.

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

###### RECEIVER

Instance id: | FXE_XAD_JF500K/DET/RECEIVER
Host: | exflcon190
Class documentation:
| JungfrauReceiver
Alias: | fxe-rr-sys-con-jungf
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: | JF500K
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

[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

###### JNGFR03

Instance id: | FXE_XAD_JF500K/DET/JNGFR03
Class id: | JungfrauReceiver
Host: | fxe-rr-sys-con-jungf
Class documentation:
| JungfrauReceiver
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | JF500K, test_please_delete_me
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

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
- 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.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]

###### CONFIG

Instance id: | FXE_XAD_JF500K/MDL/CONFIG
Class id: | JungfrauConfig
Host: | fxe-rr-sys-con-jungf
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/JungfrauMiddlelayer
Last modified: | 2021-08-26T09:20:42.499+02:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Mamchykd, Parenti, Hauf
Latest tag: | 1.2.3-2.11.1
Deployment tag: | 1.2.3-2.11.1
Scenes: | JF500K, 500K_CONFIG_DARK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, 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
- 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.3-2.11.1

Created: | 2021-07-18T14:44:36.000+02:00
Author: | mamchykd
Notes: | Summary: update daqController to 1.4.6-2.11.1

1.2.2-2.10.0

Created: | 2020-12-02T10:16:46.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update daqController to 1.4.4-2.10.0

1.2.1-2.10.0

Created: | 2020-11-23T14:10:42.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.2.0-2.8.0

Created: | 2020-11-19T14:24:50.000+01:00
Author: | Istvan Mohacsi
Notes: | Summary: New dark procedure for burst mode acquisitions. Installation: DaqController dependency added to dependencies. Devices: No change in devices. Schema: Yes, schema changed to add new functionality.

1.2.0-2.8.0-newprocedure

Created: | 2020-07-21T19:14:42.000+02:00
Author: | Istvan Mohacsi
Notes: | Preparing the dark characterization device

1.2.0-2.8.0-test

Created: | 2020-04-14T10:50:05.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.1.8-2.6.1

Created: | 2019-12-17T16:52:43.000+01:00
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T09:18:27.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T14:26:07.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T14:27:35.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T14:22:50.000+01:00
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T16:02:41.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T10:53:07.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T10:29:22.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T15:26:52.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T11:43:32.000+02:00
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T10:33:46.000+02:00
Author: | Steffen Hauf
Notes: |

###### DARK

Instance id: | FXE_XAD_JF500K/MDL/DARK
Class id: | JungfrauDarkChar
Host: | fxe-rr-sys-con-jungf
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/karaboDevices/JungfrauMiddlelayer
Last modified: | 2021-08-26T09:20:42.499+02:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Mamchykd, Parenti, Hauf
Latest tag: | 1.2.3-2.11.1
Deployment tag: | 1.2.3-2.11.1
Scenes: | JF500K, 500K_CONFIG_DARK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, mramilli, 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
- numberOfCycles:
    Number of trains (or soft triggers)
- useNewImplementation:
    Check to use the new implementation using the DAQ Controller
- storageCellStart:
    Starting storage cell for burst mode acquisitions.

Release History
1.2.3-2.11.1

Created: | 2021-07-18T14:44:36.000+02:00
Author: | mamchykd
Notes: | Summary: update daqController to 1.4.6-2.11.1

1.2.2-2.10.0

Created: | 2020-12-02T10:16:46.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update daqController to 1.4.4-2.10.0

1.2.1-2.10.0

Created: | 2020-11-23T14:10:42.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.2.0-2.8.0

Created: | 2020-11-19T14:24:50.000+01:00
Author: | Istvan Mohacsi
Notes: | Summary: New dark procedure for burst mode acquisitions. Installation: DaqController dependency added to dependencies. Devices: No change in devices. Schema: Yes, schema changed to add new functionality.

1.2.0-2.8.0-newprocedure

Created: | 2020-07-21T19:14:42.000+02:00
Author: | Istvan Mohacsi
Notes: | Preparing the dark characterization device

1.2.0-2.8.0-test

Created: | 2020-04-14T10:50:05.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.1.8-2.6.1

Created: | 2019-12-17T16:52:43.000+01:00
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T09:18:27.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T14:26:07.000+01:00
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T14:27:35.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T14:22:50.000+01:00
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T16:02:41.000+01:00
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T10:53:07.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T10:29:22.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T15:26:52.000+02:00
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T11:43:32.000+02:00
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T10:33:46.000+02:00
Author: | Steffen Hauf
Notes: |

##### ZMQ

[add component documentation]

###### CORR_GAIN

Instance id: | FXE_XAD_JF500K/ZMQ/CORR_GAIN
Class id: | PipeToZeroMQ
Host: | sa1-br-kc-comp-3
Alias: | sa1-br-kc-comp-3
Git repo: | https://git.xfel.eu/karaboDevices/PipeToZeroMQ
Last modified: | 2021-08-05T13:42:03.000+02:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Haufs, Dall’antonia, Michelat
Latest tag: | 3.2.6-2.11.0
Deployment tag: | 3.2.6-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, 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
- 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.6-2.11.0

Created: | 2021-08-05T13:41:59.000+02:00
Author: | Thomas Michelat
Notes: | Schema update compatible with karabo 2.11

3.2.5-2.11.0hotfix1

Created: | 2021-07-20T11:35:08.000+02:00
Author: | Riccardo Fabbri
Notes: |

3.2.5-2.10.0

Created: | 2020-11-26T13:52:59.000+01:00
Author: | Thomas Michelat
Notes: | Add Karabo 2.10 Versioning Info

3.2.4-2.10.0

Created: | 2020-11-18T11:03:59.000+01:00
Author: | Thomas Michelat
Notes: | Karabo 2.10 compatibility: now validate the schema of tables.

3.2.3-2.9.0

Created: | 2020-11-05T18:59:22.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.2.2-2.9.0

Created: | 2020-11-05T17:23:38.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.2.1-2.9.0

Created: | 2020-11-05T12:23:45.000+01:00
Author: | Fabio Dall’Antonia
Notes: |

3.1.1-2.9.0

Created: | 2020-06-03T10:31:31.000+02:00
Author: | Thomas Michelat
Notes: | Add new device class PipeToEXtraFoam specialized interface for EXtra-foam

3.0.1-2.7.1

Created: | 2020-03-09T17:39:08.000+01:00
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-17T19:11:31.000+01:00
Author: | Thomas Michelat
Notes: |

2.5.3-2.6.4

Created: | 2019-11-21T13:49:39.000+01:00
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T15:07:41.000+02:00
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T15:24:28.000+02:00
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T13:22:48.000+02:00
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T17:15:49.000+02:00
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T14:24:56.000+01:00
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-06T16:04:31.000+01:00
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T17:29:01.000+02:00
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-14T18:48:15.000+02:00
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-05T18:55:54.000+02:00
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

#### PH3

##### DET

###### CAMERA

Instance id: | FXE_XAD_PH3/DET/CAMERA
Host: | exflcon190
Class documentation:
| PhotonDetector
Alias: | fxe-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genicamCameras
Last modified: | 2019-09-27T12:13:05.000+02:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Ehsan
Latest tag: | 3.11.3-2.6.1
Deployment tag: | 3.11.2-2.6.0
Scenes: | FXE_XAD_PH3/DET/CAMERA|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

### XTD2

#### UND

##### DOOCS

###### ENERGY

Instance id: | FXE_XTD2_UND/DOOCS/ENERGY
Class id: | DoocsUndulatorEnergy
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Scenes: | FXE_XTD2_UND/DOOCS/ENERGY, FXE_MONO/MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.14-2.11.1) does not match tags mentioned in the deployment ([‘1.8.16-2.11.1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- location:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- calibrateTarget:
    The calibration factor will be computed by using this energy when hitting calibrate slot
- calibrate:
    Calibrate calibration factor. α = actual energy / Calibrate Target
- move:
    Move Undulators to target Energy
- stop:
    Stop time shifting with the phase shifter.
- tolerance:
    Tolerance is in unit %, i.e. relative to the actual position.
- calibrationFactor:
    Calibration Factor for the scaling of the target energy.
- busy:
    Status flag, 1: if Undulators are moving, 0: if undulators are not moving
- updateInterval:
    Polling Interval to get updated values from DOOCS

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

### XTD9

#### DG

##### CAM

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DCTRL

###### APERTURE_CYLINDER

Instance id: | FXE_XTD9_DG/DCTRL/APERTURE_CYLINDER
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Diamond Grating XTD9
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LIGHT_CAMERA

Instance id: | FXE_XTD9_DG/DCTRL/LIGHT_CAMERA
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Grating Cam, Diamond Grating XTD9
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### X_ROLL

Instance id: | FXE_XTD9_DG/ENC/X_ROLL
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### X_TRANS

Instance id: | FXE_XTD9_DG/ENC/X_TRANS
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### Y_TRANS

Instance id: | FXE_XTD9_DG/ENC/Y_TRANS
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

##### MOTOR

###### X_ROLL

Instance id: | FXE_XTD9_DG/MOTOR/X_ROLL
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_XTD9_DG/MOTOR/X_ROLL|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’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### X_TRANS

Instance id: | FXE_XTD9_DG/MOTOR/X_TRANS
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_XTD9_DG/MOTOR/X_TRANS|motorScene, FXE_XTD9_DG/MOTOR/X_TRANS|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’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### Y_TRANS

Instance id: | FXE_XTD9_DG/MOTOR/Y_TRANS
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_XTD9_DG/MOTOR/Y_TRANS|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’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### INOUTX

Instance id: | FXE_XTD9_DG/MDL/INOUTX
Class id: | BeamImagingUnit
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
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: | FXE_OGT1-SpA1_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
- 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
- moveIN:
    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: |

#### MONO-1

##### ACTRL

###### TOP_XTAL_FPITCH

Instance id: | FXE_XTD9_MONO-1/ACTRL/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | FXE_MONO1_FPITCH_TEST
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### U0

Instance id: | FXE_XTD9_MONO-1/ACTRL/U0
Class id: | BeckhoffAnalogOutput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-1
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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
- 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.
- 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.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: |

###### U1

Instance id: | FXE_XTD9_MONO-1/ACTRL/U1
Class id: | BeckhoffAnalogOutput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-1
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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
- 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.
- 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.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: |

###### U2

Instance id: | FXE_XTD9_MONO-1/ACTRL/U2
Class id: | BeckhoffAnalogOutput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-1
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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
- 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.
- 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.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: |

###### HT1_I_PROG

Instance id: | FXE_XTD9_MONO-1/ACTRL/HT1_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT1_V_PROG

Instance id: | FXE_XTD9_MONO-1/ACTRL/HT1_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT2_I_PROG

Instance id: | FXE_XTD9_MONO-1/ACTRL/HT2_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT2_V_PROG

Instance id: | FXE_XTD9_MONO-1/ACTRL/HT2_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT3_I_PROG

Instance id: | FXE_XTD9_MONO-1/ACTRL/HT3_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT3_V_PROG

Instance id: | FXE_XTD9_MONO-1/ACTRL/HT3_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### I0

Instance id: | FXE_XTD9_MONO-1/ASENS/I0
Class id: | BeckhoffAnalogInput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-1
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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: |

###### I1

Instance id: | FXE_XTD9_MONO-1/ASENS/I1
Class id: | BeckhoffAnalogInput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-1
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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: |

###### I2

Instance id: | FXE_XTD9_MONO-1/ASENS/I2
Class id: | BeckhoffAnalogInput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-1
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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: |

###### TOP_XTAL_FPITCH

Instance id: | FXE_XTD9_MONO-1/ASENS/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | FXE_MONO1_FPITCH_TEST
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL

Instance id: | FXE_XTD9_MONO-1/ASENS/TOP_XTAL_ROLL
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH

Instance id: | FXE_XTD9_MONO-1/ASENS/TOP_XTAL_RPITCH
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_I_MON

Instance id: | FXE_XTD9_MONO-1/ASENS/HT1_I_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_V_MON

Instance id: | FXE_XTD9_MONO-1/ASENS/HT1_V_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_I_MON

Instance id: | FXE_XTD9_MONO-1/ASENS/HT2_I_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_V_MON

Instance id: | FXE_XTD9_MONO-1/ASENS/HT2_V_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_I_MON

Instance id: | FXE_XTD9_MONO-1/ASENS/HT3_I_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_V_MON

Instance id: | FXE_XTD9_MONO-1/ASENS/HT3_V_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### AVG

###### BEAMVIEW

Instance id: | FXE_XTD9_MONO-1/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
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
Scenes: | FXE_XTD9_MONO-1-AVG-BEAMVIEW-scene0
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!

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, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The 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
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

###### BEAMVIEW

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DCTRL

###### CAM_POWER

Instance id: | FXE_XTD9_MONO-1/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_XTD9_MONO-1-CAM-BEAMVIEW-scene, FXE_XTD9_MONO-1/CAM/BEAMVIEW|scene, FXE_XTD9_MONO-1-AVG-BEAMVIEW-scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYO_POWER

Instance id: | FXE_XTD9_MONO-1/DCTRL/CRYO_POWER
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | MONO-CRYO-POWER, VAC-SIGNALS, MONO-CRYO-POWER, Temperature0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYO_POWER_2VAC

Instance id: | FXE_XTD9_MONO-1/DCTRL/CRYO_POWER_2VAC
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MONO-CRYO-POWER, MONO-CRYO-POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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_POWER

Instance id: | FXE_XTD9_MONO-1/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | FXE_MONO1_FPITCH_TEST, FXE_XTD9_MONO-1-CAM-BEAMVIEW-scene, FXE_XTD9_MONO-1/CAM/BEAMVIEW|scene, FXE_XTD9_MONO-1-AVG-BEAMVIEW-scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_LIDLE

Instance id: | FXE_XTD9_MONO-1/DCTRL/TOP_XTAL_ROLL_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Pico mono 1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_SWITCH

Instance id: | FXE_XTD9_MONO-1/DCTRL/TOP_XTAL_ROLL_SWITCH
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Pico mono 1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_LIDLE

Instance id: | FXE_XTD9_MONO-1/DCTRL/TOP_XTAL_RPITCH_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Pico mono 1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_SWITCH

Instance id: | FXE_XTD9_MONO-1/DCTRL/TOP_XTAL_RPITCH_SWITCH
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Pico mono 1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_ENABLE

Instance id: | FXE_XTD9_MONO-1/DCTRL/HT1_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_REM_SEL

Instance id: | FXE_XTD9_MONO-1/DCTRL/HT1_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_ENABLE

Instance id: | FXE_XTD9_MONO-1/DCTRL/HT2_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_REM_SEL

Instance id: | FXE_XTD9_MONO-1/DCTRL/HT2_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_ENABLE

Instance id: | FXE_XTD9_MONO-1/DCTRL/HT3_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_REM_SEL

Instance id: | FXE_XTD9_MONO-1/DCTRL/HT3_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### ACCM_PITCH

Instance id: | FXE_XTD9_MONO-1/ENC/ACCM_PITCH
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH|motorScene, FXE_Mono1_Alio_Scanning, STAGE_LINEARITY_TEST
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### TX

Instance id: | FXE_XTD9_MONO-1/ENC/TX
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | FXE_XTD9_MONO-1/MOTOR/TX|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’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### TY

Instance id: | FXE_XTD9_MONO-1/ENC/TY
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

##### MDL

###### ACCM_PITCH

Instance id: | FXE_XTD9_MONO-1/MDL/ACCM_PITCH
Class id: | MonoChromator
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/monoChromatorEnergyChanger
Last modified: | 2021-06-11T16:27:36.000+02:00
Created at: | 2018-07-19T15:59:24.000+02:00
Main authors: | Hauf, Parenti, Degon
Latest tag: | 1.6.3-2.10.0
Deployment tag: | 1.6.3-2.10.0
Scenes: | FXE_XTD9_MONO-1/MDL/ACCM_PITCH|scene, FXE_XTD9_MONO/MDL/ACCM_PITCH_OLD, TEST-SCENE-MONO-1, FXE_XTD9_MONO/MDL/ACCM_PITCH, FXE_MONO/MAIN, MONO-1, FXE_Mono1_Alio_Scanning, TEST-SCENE-MONO-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
- pitchMotor:
    FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH
- proposedPosition:
    Proposed Position
- barLength:
    Distance between the linear translation axis and center of rotation of long arm including direction
- conversion:
    Conversion parameter for Si111 at ambient conditions, d = qhce/4pi
- angularOffset:
    Offset. It will only be applied after calibration
- calibrate:
    Calibrate actual position to calibrated position
- calibrateTarget:
    Calibrate the target position of the monochromator. Thisaction persists the values of the calibrated energy and motor positon on disk
- calibratedPosition:
    Calibrated Position
- calibratedEnergy:
    Calibrated Energy
- translationOffset:
    Translation stage offset, Xo
- actualEnergy:
    The actual energy, If connected, motor target positionis automatically refreshed.
- targetEnergy:
    This is the Target energy setting.
- on:
    Turn On Motor
- findTarget:
    Calculates actuator positions for the desired target energy
- moveTarget:
    Drives the motor to the desired Target energy value
- stop:
    Stop monochromator motion.

Release History
1.6.3-2.10.0

Created: | 2021-06-11T12:41:03.000+02:00
Author: | Wajid Ehsan
Notes: | Fix actual energy

1.6.2-2.10.0

Created: | 2020-11-23T12:26:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.6.1-2.9.0

Created: | 2020-09-11T13:09:42.000+02:00
Author: | Wajid Ehsan
Notes: |

1.6.0-2.6.0

Created: | 2019-09-03T16:31:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.5.0-2.5.0

Created: | 2019-08-28T14:38:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.4.1-2.4.0

Created: | 2019-06-20T18:05:38.000+02:00
Author: | Wajid Ehsan
Notes: | Device generated scene

1.4.0-2.4.0

Created: | 2019-06-13T19:06:55.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of relative geometry as a new class

1.3.1-2.4.0

Created: | 2019-04-25T13:18:28.000+02:00
Author: | Wajid Ehsan
Notes: | Get actual position from master motor

1.3.0-2.4.0

Created: | 2019-04-08T13:42:45.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of monochromator group with a scan tool

1.2.0-2.3.1

Created: | 2019-03-20T16:02:17.000+01:00
Author: | Wajid Ehsan
Notes: | Save data in a permanent directory

1.1.0-2.2.5

Created: | 2019-01-07T16:03:45.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.5

Created: | 2018-11-13T18:02:28.000+01:00
Author: | Wajid Ehsan
Notes: |

###### INOUTX

Instance id: | FXE_XTD9_MONO-1/MDL/INOUTX
Class id: | BeamImagingUnit
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
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: | FXE_XTD9_MONO/IN_OUT_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
- 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
- moveIN:
    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: |

###### INOUTY

Instance id: | FXE_XTD9_MONO-1/MDL/INOUTY
Class id: | BeamImagingUnit
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
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: | FXE_XTD9_MONO/IN_OUT_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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveMONO1_ONLY:
    Moves the motor to the position marked with this label
- moveIN:
    Moves the motor to the position marked with this label
- moveOUT:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

###### ACCM_PITCH

Instance id: | FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH|motorScene, FXE_XTD9_MONO-1/MDL/ACCM_PITCH|scene, FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH|motorScene, FXE_XTD9_MONO/MDL/ACCM_PITCH_OLD, TEST-SCENE-MONO-1, FXE_XTD9_MONO/MDL/ACCM_PITCH, FXE_MONO/MAIN, MONO-1, FXE_Mono1_Alio_Scanning, TEST-SCENE-MONO-1, Temperature0, STAGE_LINEARITY_TEST
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL

Instance id: | FXE_XTD9_MONO-1/MOTOR/TOP_XTAL_ROLL
Class id: | BeckhoffMC2Base
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | Pico mono 1, FXE_XTD9_MONO-1-MOTOR-TOP_XTAL_ROLL_LIDLE, FXE_XTD9_MONO-1-MOTOR-TOP_XTAL_ROLL_LFAULT, FXE_XTD9_MONO-1-MOTOR-TOP_XTAL_ROLL_SWITCH, FXE_XTD9_MONO-1-MOTOR-TOP_XTAL_ROLL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TOP_XTAL_RPITCH

Instance id: | FXE_XTD9_MONO-1/MOTOR/TOP_XTAL_RPITCH
Class id: | BeckhoffMC2Base
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | Pico mono 1, FXE_XTD9_MONO-1-MOTOR-TOP_XTAL_RPITCH_LFAULT, FXE_XTD9_MONO-1-MOTOR-TOP_XTAL_RPITCH_LIDLE, FXE_XTD9_MONO-1-MOTOR-TOP_XTAL_RPITCH_SWITCH, FXE_XTD9_MONO-1-MOTOR-TOP_XTAL_RPITCH
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TX

Instance id: | FXE_XTD9_MONO-1/MOTOR/TX
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | FXE_XTD9_MONO-1/MOTOR/TX|motorScene, FXE_XTD9_MONO-1/MOTOR/TX, FXE_XTD9_MONO-1-MOTOR-TX, FXE_XTD9_MONO-1/MOTOR/TX, FXE_XTD9_MONO/IN_OUT_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’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TY

Instance id: | FXE_XTD9_MONO-1/MOTOR/TY
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | FXE_XTD9_MONO-1/MOTOR/TY|motorScene, FXE_XTD9_MONO-1/MOTOR/TY, FXE_XTD9_MONO-1-MOTOR-TY, FXE_XTD9_MONO-1/MOTOR/TY, FXE_XTD9_MONO/IN_OUT_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’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### PROC

###### BEAMVIEW

Instance id: | FXE_XTD9_MONO-1/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | fxe-br-sys-con-12
Class documentation:
| ImageProcessor
Alias: | fxe-br-sys-con-12
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
Scenes: | FXE_XTD9_MONO-1-CAM-BEAMVIEW-scene, FXE_Mono1_Alio_Scanning, FXE_XTD9_MONO-1/CAM/BEAMVIEW|scene, FXE_XTD9_MONO-1-AVG-BEAMVIEW-scene0
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!

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, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The 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
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 peak position from 1D fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 peak position from 1D fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 peak position from 2D fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 peak position from 2D fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

###### TOP_XTAL_ROLL_LFAULT

Instance id: | FXE_XTD9_MONO-1/SWITCH/TOP_XTAL_ROLL_LFAULT
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TOP_XTAL_RPITCH_LFAULT

Instance id: | FXE_XTD9_MONO-1/SWITCH/TOP_XTAL_RPITCH_LFAULT
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT1_IS_LOC

Instance id: | FXE_XTD9_MONO-1/SWITCH/HT1_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT2_IS_LOC

Instance id: | FXE_XTD9_MONO-1/SWITCH/HT2_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT3_IS_LOC

Instance id: | FXE_XTD9_MONO-1/SWITCH/HT3_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono1Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T0

Instance id: | FXE_XTD9_MONO-1/TSENS/T0
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | Mono1Temperature, MONO1_TEMP, MONO-CRYO-POWER, MONO-CRYO-POWER, Temperature0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T1

Instance id: | FXE_XTD9_MONO-1/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | Mono1Temperature, MONO1_TEMP, MONO-CRYO-POWER, MONO-CRYO-POWER, Temperature0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_XTD9_MONO-1/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-1
Scenes: | Mono1Temperature, MONO1_TEMP, MONO-CRYO-POWER, MONO-CRYO-POWER, Temperature0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### MONO-2

##### ACTRL

###### TOP_XFAL_FPITCH

Instance id: | FXE_XTD9_MONO-2/ACTRL/TOP_XFAL_FPITCH
Class id: | BeckhoffAnalogOutput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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
- 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.
- 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.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: |

###### U0

Instance id: | FXE_XTD9_MONO-2/ACTRL/U0
Class id: | BeckhoffAnalogOutput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-2
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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
- 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.
- 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.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: |

###### U1

Instance id: | FXE_XTD9_MONO-2/ACTRL/U1
Class id: | BeckhoffAnalogOutput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-2
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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
- 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.
- 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.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: |

###### U2

Instance id: | FXE_XTD9_MONO-2/ACTRL/U2
Class id: | BeckhoffAnalogOutput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-2
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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
- 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.
- 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.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: |

###### HT1_I_PROG

Instance id: | FXE_XTD9_MONO-2/ACTRL/HT1_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT1_V_PROG

Instance id: | FXE_XTD9_MONO-2/ACTRL/HT1_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT2_I_PROG

Instance id: | FXE_XTD9_MONO-2/ACTRL/HT2_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT2_V_PROG

Instance id: | FXE_XTD9_MONO-2/ACTRL/HT2_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT3_I_PROG

Instance id: | FXE_XTD9_MONO-2/ACTRL/HT3_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT3_V_PROG

Instance id: | FXE_XTD9_MONO-2/ACTRL/HT3_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TOP_XTAL_FPITCH

Instance id: | FXE_XTD9_MONO-2/ACTRL/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### I0

Instance id: | FXE_XTD9_MONO-2/ASENS/I0
Class id: | BeckhoffAnalogInput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-2
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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: |

###### I1

Instance id: | FXE_XTD9_MONO-2/ASENS/I1
Class id: | BeckhoffAnalogInput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-2
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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: |

###### I2

Instance id: | FXE_XTD9_MONO-2/ASENS/I2
Class id: | BeckhoffAnalogInput
Host: | exflcon54n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Projects: | FXE_XTD9_MONO-2
Scenes: | Heaters
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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: |

###### TOP_XTAL_FPITCH

Instance id: | FXE_XTD9_MONO-2/ASENS/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL

Instance id: | FXE_XTD9_MONO-2/ASENS/TOP_XTAL_ROLL
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH

Instance id: | FXE_XTD9_MONO-2/ASENS/TOP_XTAL_RPITCH
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_I_MON

Instance id: | FXE_XTD9_MONO-2/ASENS/HT1_I_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_V_MON

Instance id: | FXE_XTD9_MONO-2/ASENS/HT1_V_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_I_MON

Instance id: | FXE_XTD9_MONO-2/ASENS/HT2_I_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_V_MON

Instance id: | FXE_XTD9_MONO-2/ASENS/HT2_V_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_I_MON

Instance id: | FXE_XTD9_MONO-2/ASENS/HT3_I_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_V_MON

Instance id: | FXE_XTD9_MONO-2/ASENS/HT3_V_MON
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### AVG

###### BEAMVIEW

Instance id: | FXE_XTD9_MONO-2/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
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
Scenes: | FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0
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!

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, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The 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
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

###### BEAMVIEW

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DCTRL

###### CAM_POWER

Instance id: | FXE_XTD9_MONO-2/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_XTD9_MONO-2/CAM/BEAMVIEW|scene, FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYO_POWER

Instance id: | FXE_XTD9_MONO-2/DCTRL/CRYO_POWER
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | MONO-CRYO-POWER, Temperature0_Mono2, VAC-SIGNALS, MONO-CRYO-POWER, Temperature0_Mono2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYO_POWER_2VAC

Instance id: | FXE_XTD9_MONO-2/DCTRL/CRYO_POWER_2VAC
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MONO-CRYO-POWER, MONO-CRYO-POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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_POWER

Instance id: | FXE_XTD9_MONO-2/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | FXE_XTD9_MONO-2/CAM/BEAMVIEW|scene, FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_LIDLE

Instance id: | FXE_XTD9_MONO-2/DCTRL/TOP_XTAL_ROLL_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | pico mono 2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_SWITCH

Instance id: | FXE_XTD9_MONO-2/DCTRL/TOP_XTAL_ROLL_SWITCH
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | pico mono 2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_LIDLE

Instance id: | FXE_XTD9_MONO-2/DCTRL/TOP_XTAL_RPITCH_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | pico mono 2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_SWITCH

Instance id: | FXE_XTD9_MONO-2/DCTRL/TOP_XTAL_RPITCH_SWITCH
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | pico mono 2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_ENABLE

Instance id: | FXE_XTD9_MONO-2/DCTRL/HT1_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_REM_SEL

Instance id: | FXE_XTD9_MONO-2/DCTRL/HT1_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_ENABLE

Instance id: | FXE_XTD9_MONO-2/DCTRL/HT2_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_REM_SEL

Instance id: | FXE_XTD9_MONO-2/DCTRL/HT2_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_ENABLE

Instance id: | FXE_XTD9_MONO-2/DCTRL/HT3_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_REM_SEL

Instance id: | FXE_XTD9_MONO-2/DCTRL/HT3_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### ACCM_PITCH

Instance id: | FXE_XTD9_MONO-2/ENC/ACCM_PITCH
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH|motorScene, FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### TX

Instance id: | FXE_XTD9_MONO-2/ENC/TX
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | FXE_XTD9_MONO-2/MOTOR/TX|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’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### TY

Instance id: | FXE_XTD9_MONO-2/ENC/TY
Class id: | BeckhoffEncoder
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | FXE_XTD9_MONO-2/MOTOR/TY|motorScene, FXE_XTD9_MONO-1/MOTOR/TY|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’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

##### MDL

###### ACCM_PITCH

Instance id: | FXE_XTD9_MONO-2/MDL/ACCM_PITCH
Class id: | MonoChromator
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/monoChromatorEnergyChanger
Last modified: | 2021-06-11T16:27:36.000+02:00
Created at: | 2018-07-19T15:59:24.000+02:00
Main authors: | Hauf, Parenti, Degon
Latest tag: | 1.6.3-2.10.0
Deployment tag: | 1.6.3-2.10.0
Scenes: | TEST-SCENE-MONO-2, FXE_XTD9_MONO-2/MDL/ACCM_PITCH|scene, FXE_XTD9_MONO/MDL/ACCM_PITCH_OLD, FXE_XTD9_MONO/MDL/ACCM_PITCH, FXE_MONO/MAIN, TEST-SCENE-MONO-2, FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0, MONO-2
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
- pitchMotor:
    FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH
- proposedPosition:
    Proposed Position
- barLength:
    Distance between the linear translation axis and center of rotation of long arm including direction
- conversion:
    Conversion parameter for Si111 at ambient conditions, d = qhce/4pi
- angularOffset:
    Offset. It will only be applied after calibration
- calibrate:
    Calibrate actual position to calibrated position
- calibrateTarget:
    Calibrate the target position of the monochromator. Thisaction persists the values of the calibrated energy and motor positon on disk
- calibratedPosition:
    Calibrated Position
- calibratedEnergy:
    Calibrated Energy
- translationOffset:
    Translation stage offset, Xo
- actualEnergy:
    The actual energy, If connected, motor target positionis automatically refreshed.
- targetEnergy:
    This is the Target energy setting.
- on:
    Turn On Motor
- findTarget:
    Calculates actuator positions for the desired target energy
- moveTarget:
    Drives the motor to the desired Target energy value
- stop:
    Stop monochromator motion.

Release History
1.6.3-2.10.0

Created: | 2021-06-11T12:41:03.000+02:00
Author: | Wajid Ehsan
Notes: | Fix actual energy

1.6.2-2.10.0

Created: | 2020-11-23T12:26:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.6.1-2.9.0

Created: | 2020-09-11T13:09:42.000+02:00
Author: | Wajid Ehsan
Notes: |

1.6.0-2.6.0

Created: | 2019-09-03T16:31:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.5.0-2.5.0

Created: | 2019-08-28T14:38:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.4.1-2.4.0

Created: | 2019-06-20T18:05:38.000+02:00
Author: | Wajid Ehsan
Notes: | Device generated scene

1.4.0-2.4.0

Created: | 2019-06-13T19:06:55.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of relative geometry as a new class

1.3.1-2.4.0

Created: | 2019-04-25T13:18:28.000+02:00
Author: | Wajid Ehsan
Notes: | Get actual position from master motor

1.3.0-2.4.0

Created: | 2019-04-08T13:42:45.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of monochromator group with a scan tool

1.2.0-2.3.1

Created: | 2019-03-20T16:02:17.000+01:00
Author: | Wajid Ehsan
Notes: | Save data in a permanent directory

1.1.0-2.2.5

Created: | 2019-01-07T16:03:45.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.5

Created: | 2018-11-13T18:02:28.000+01:00
Author: | Wajid Ehsan
Notes: |

###### INOUTX

Instance id: | FXE_XTD9_MONO-2/MDL/INOUTX
Class id: | BeamImagingUnit
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
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: | FXE_XTD9_MONO/IN_OUT_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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveIN:
    Moves the motor to the position marked with this label
- moveOUT:
    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: |

###### INOUTY

Instance id: | FXE_XTD9_MONO-2/MDL/INOUTY
Class id: | BeamImagingUnit
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
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: | FXE_XTD9_MONO/IN_OUT_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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveIN:
    Moves the motor to the position marked with this label
- moveOUT:
    Moves the motor to the position marked with this label
- moveMONO2_ONLY:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

###### ACCM_PITCH

Instance id: | FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST-SCENE-MONO-2, FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH|motorScene, FXE_XTD9_MONO-2/MDL/ACCM_PITCH|scene, FXE_XTD9_MONO/MDL/ACCM_PITCH_OLD, FXE_XTD9_MONO/MDL/ACCM_PITCH, FXE_MONO/MAIN, FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH|motorScene, TEST-SCENE-MONO-2, FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0, MONO-2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL

Instance id: | FXE_XTD9_MONO-2/MOTOR/TOP_XTAL_ROLL
Class id: | BeckhoffMC2Base
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | pico mono 2, FXE_XTD9_MONO-2-MOTOR-TOP_XTAL_ROLL, FXE_XTD9_MONO-2-MOTOR-TOP_XTAL_ROLL_LFAULT, FXE_XTD9_MONO-2-MOTOR-TOP_XTAL_ROLL_LIDLE, FXE_XTD9_MONO-2-MOTOR-TOP_XTAL_ROLL_SWITCH
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TOP_XTAL_RPITCH

Instance id: | FXE_XTD9_MONO-2/MOTOR/TOP_XTAL_RPITCH
Class id: | BeckhoffMC2Base
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | FXE_XTD9_MONO-2-MOTOR-TOP_XTAL_RPITCH_LFAULT, pico mono 2, FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0, FXE_XTD9_MONO-2-MOTOR-TOP_XTAL_RPITCH_LIDLE, FXE_XTD9_MONO-2-MOTOR-TOP_XTAL_RPITCH_SWITCH, FXE_XTD9_MONO-2-MOTOR-TOP_XTAL_RPITCH
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TX

Instance id: | FXE_XTD9_MONO-2/MOTOR/TX
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | FXE_XTD9_MONO-2/MOTOR/TX, FXE_XTD9_MONO-2/MOTOR/TX|motorScene, FXE_XTD9_MONO-2-MOTOR-TX, FXE_XTD9_MONO-2/MOTOR/TX, FXE_XTD9_MONO/IN_OUT_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’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TY

Instance id: | FXE_XTD9_MONO-2/MOTOR/TY
Class id: | BeckhoffSimpleMotor
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | FXE_XTD9_MONO-2/MOTOR/TY|motorScene, FXE_XTD9_MONO-1/MOTOR/TY|motorScene, FXE_XTD9_MONO-2/MOTOR/TY, FXE_XTD9_MONO-2-MOTOR-TY, FXE_XTD9_MONO-2/MOTOR/TY, FXE_XTD9_MONO/IN_OUT_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’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### PROC

###### BEAMVIEW

Instance id: | FXE_XTD9_MONO-2/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | fxe-br-sys-con-12
Class documentation:
| ImageProcessor
Alias: | fxe-br-sys-con-12
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
Scenes: | FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0
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!

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, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The 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
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 peak position from 1D fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 peak position from 1D fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 peak position from 2D fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 peak position from 2D fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

###### TOP_XTAL_ROLL_LFAULT

Instance id: | FXE_XTD9_MONO-2/SWITCH/TOP_XTAL_ROLL_LFAULT
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### TOP_XTAL_RPITCH_LFAULT

Instance id: | FXE_XTD9_MONO-2/SWITCH/TOP_XTAL_RPITCH_LFAULT
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT1_IS_LOC

Instance id: | FXE_XTD9_MONO-2/SWITCH/HT1_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT2_IS_LOC

Instance id: | FXE_XTD9_MONO-2/SWITCH/HT2_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### HT3_IS_LOC

Instance id: | FXE_XTD9_MONO-2/SWITCH/HT3_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Mono2Heaters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### T0

Instance id: | FXE_XTD9_MONO-2/TSENS/T0
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | MONO2_TEMP, MONO-CRYO-POWER, Temperature0_Mono2, Temperature, MONO-CRYO-POWER, Temperature0_Mono2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T1

Instance id: | FXE_XTD9_MONO-2/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | MONO2_TEMP, MONO-CRYO-POWER, Temperature0_Mono2, Temperature, MONO-CRYO-POWER, Temperature0_Mono2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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: | FXE_XTD9_MONO-2/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
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: | FXE_XTD9_MONO-2
Scenes: | MONO2_TEMP, MONO-CRYO-POWER, Temperature0_Mono2, Temperature, MONO-CRYO-POWER, Temperature0_Mono2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### MONO

##### MDL

###### ACCM_PITCH

Instance id: | FXE_XTD9_MONO/MDL/ACCM_PITCH
Class id: | MonoChromatorGroup
Host: | fxe-br-sys-con-12
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/monoChromatorEnergyChanger
Last modified: | 2021-06-11T16:27:36.000+02:00
Created at: | 2018-07-19T15:59:24.000+02:00
Main authors: | Hauf, Parenti, Degon
Latest tag: | 1.6.3-2.10.0
Deployment tag: | 1.6.3-2.10.0
Scenes: | FXE_XTD9_MONO/MDL/ACCM_PITCH_OLD, FXE_XTD9_MONO/MDL/ACCM_PITCH, FXE_MONO/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!

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:

    Interface required for Scan tool

- masterNode:

    Master Node to be used for Actual Position

- actualPosition:

    This is the Actual energy setting.

- targetPosition:

    This is the Target energy setting.

- turnOn:

    Turn on all motors

- move:

    Move command.

- stop:

  > “Send stop signal” button, action is not immediate. The timeout is set to 5 sec.

Release History
1.6.3-2.10.0

Created: | 2021-06-11T12:41:03.000+02:00
Author: | Wajid Ehsan
Notes: | Fix actual energy

1.6.2-2.10.0

Created: | 2020-11-23T12:26:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.6.1-2.9.0

Created: | 2020-09-11T13:09:42.000+02:00
Author: | Wajid Ehsan
Notes: |

1.6.0-2.6.0

Created: | 2019-09-03T16:31:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.5.0-2.5.0

Created: | 2019-08-28T14:38:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.4.1-2.4.0

Created: | 2019-06-20T18:05:38.000+02:00
Author: | Wajid Ehsan
Notes: | Device generated scene

1.4.0-2.4.0

Created: | 2019-06-13T19:06:55.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of relative geometry as a new class

1.3.1-2.4.0

Created: | 2019-04-25T13:18:28.000+02:00
Author: | Wajid Ehsan
Notes: | Get actual position from master motor

1.3.0-2.4.0

Created: | 2019-04-08T13:42:45.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of monochromator group with a scan tool

1.2.0-2.3.1

Created: | 2019-03-20T16:02:17.000+01:00
Author: | Wajid Ehsan
Notes: | Save data in a permanent directory

1.1.0-2.2.5

Created: | 2019-01-07T16:03:45.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.5

Created: | 2018-11-13T18:02:28.000+01:00
Author: | Wajid Ehsan
Notes: |

##### SWITCH

###### VAC_OK

Instance id: | FXE_XTD9_MONO/SWITCH/VAC_OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | VAC-SIGNALS, MONO-CRYO-POWER, VAC-SIGNALS, MONO-CRYO-POWER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### VAC

##### SWITCH

###### SHUT_aclose

Instance id: | FXE_XTD9_VAC/SWITCH/SHUT_aclose
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | INTERLOCK_SIGNALS, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### SHUT_open

Instance id: | FXE_XTD9_VAC/SWITCH/SHUT_open
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | INTERLOCK_SIGNALS, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### IMGPI

[add component documentation]

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | FXE_XTD9_IMGPI/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | fxe-rr-sys-con-13
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-13
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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- performanceStatistics:
    Accumulates some statistics
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

### PPL

#### LAS

##### MOTOR

###### STAGE_1

Instance id: | FXE_PPL_LAS/MOTOR/STAGE_1
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | FXE_PPL_LAS/MOTOR/STAGE_1|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
- 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:
    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

###### STAGE_2

Instance id: | FXE_PPL_LAS/MOTOR/STAGE_2
Class id: | BeckhoffMC2Base
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
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: | FXE_PPL_LAS/MOTOR/STAGE_2|motorScene
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.

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

### ILH

[add component documentation]

#### PPL

[add component documentation]

##### AVG

[add component documentation]

###### REF_POS1

Instance id: | FXE_ILH_PPL/AVG/REF_POS1
Class id: | ImageAverager
Host: | exflcon19n0
Alias: | fxe-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image 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.

###### REF_POS2

Instance id: | FXE_ILH_PPL/AVG/REF_POS2
Class id: | ImageAverager
Host: | exflcon19n0
Alias: | fxe-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image 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]

###### REF_POS1

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

###### REF_POS2

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

##### PROC

[add component documentation]

###### REF_POS1

Instance id: | FXE_ILH_PPL/PROC/REF_POS1
Class id: | ImageProcessor
Host: | exflcon19n0
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.

###### REF_POS2

Instance id: | FXE_ILH_PPL/PROC/REF_POS2
Class id: | ImageProcessor
Host: | exflcon19n0
Class documentation:
| ImageProcessor
Alias: | fxe-rr-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FXE_ILH_PPL/CAM/REF_POS2|scene, REF_POS2_diag
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

#### AUX

[add component documentation]

##### MOTOR

[add component documentation]

###### AUX01

###### AUX02

###### AUX03

###### AUX04

###### AUX05

###### AUX06

###### AUX07

###### AUX08

###### AUX09

###### AUX10

#### CHILLER

[add component documentation]

##### DCTRL

[add component documentation]

###### CHILLER_1_REMOTESTART

Instance id: | FXE_ILH_CHILLER/DCTRL/CHILLER_1_REMOTESTART
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CHILLER_2_REMOTESTART

Instance id: | FXE_ILH_CHILLER/DCTRL/CHILLER_2_REMOTESTART
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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]

###### CHILLER_1_COLLECTIVEALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_1_COLLECTIVEALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_FLOWALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_1_FLOWALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_GUIDEVALUEALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_1_GUIDEVALUEALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_PRESSUREALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_1_PRESSUREALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_TEMPERATUREALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_1_TEMPERATUREALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_WATERALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_1_WATERALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_2_COLLECTIVEALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_2_COLLECTIVEALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_2_FLOWALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_2_FLOWALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_2_GUIDEVALUEALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_2_GUIDEVALUEALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_2_PRESSUREALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_2_PRESSUREALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_2_TEMPERATUREALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_2_TEMPERATUREALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_2_WATERALARM

Instance id: | FXE_ILH_CHILLER/SWITCH/CHILLER_2_WATERALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

#### TA

[add component documentation]

##### CAL

[add component documentation]

###### CONTROL

Instance id: | FXE_ILH_TA/CAL/CONTROL
Class id: | SlsCalibrator
Host: | fxe-rr-sys-con-7
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/slsCalibrator
Last modified: | 2021-08-06T08:25:04.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Parenti, Hauf, Danilevski
Latest tag: | 1.5.1-2.11.0
Deployment tag: | 1.5.1-2.11.0
Scenes: | FXE_ILH_TA/DET/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!

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
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- bkg:
    The background on ADC counts.
- cal:
    The calibration constants [keV/counts].
- averagedDisplay:
    Average all the frames in the train and then display.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.
- useBackgroundFrame:
    Use Frame for Background subtraction
- frameNumber:
    The index of the frame to be used for background subtraction
- errorCount:
    Number of errors.
- reset:
    Reset error count.

Release History
1.5.1-2.11.0

Created: | 2021-08-04T16:24:38.000+02:00
Author: | Alessandro Silenzi
Notes: | revert change in schema types.

1.5.0-2.11.0

Created: | 2021-07-26T17:39:35.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: output channel data matches the type in the schema. Schema changed properties VECTOR_FLOAT -> VECTOR_DOUBLE

1.4.1-2.10.0

Created: | 2020-11-24T12:14:02.000+01:00
Author: | Andrea Parenti
Notes: | Summary: added version info

1.4.0-2.5.1

Created: | 2019-08-08T15:22:44.000+02:00
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T14:31:43.000+02:00
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T12:01:40.000+02:00
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T13:58:56.000+01:00
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T10:34:30.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T14:50:05.000+01:00
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T11:28:08.000+01:00
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T18:29:31.000+02:00
Author: | Andrea Parenti
Notes: |

##### CAM

[add component documentation]

###### SPEC_CAM

##### DET

[add component documentation]

###### CONTROL

Instance id: | FXE_ILH_TA/DET/CONTROL
Class id: | GotthardControl
Host: | fxe-rr-sys-con-7
Class documentation:
| GotthardControl
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_ILH_TA/DET/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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Starts acquisition
- stop:
    Stops acquisition
- reset:
    Resets the device in case of an error
- detectorHostName:
    Detector Host Name
- detectorIp:
    Detector IP. Must be on the same subnet as the receiver.
- detectorHostPort:
    Detector Host Port. Will use 1952 if left empty.
- detectorHostStopPort:
    Detector Host Stop Port. Will use 1953 if left empty.
- rxHostname:
    Receiver Hostname
- rxTcpPort:
    Receiver TCP Port
- rxUdpIp:
    Receiver UDP IP
- rxUdpPort:
    Receiver UDP Port
- settings:
    Settings
- online:
    Sets the detector in online (1) or offline (0) mode.
- angDir:
    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).
- moveFlag:
    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)
- lock:
    lock
- extSig0:
    Ext Sig 0
- vHighVoltageMax:
    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.
- vHighVoltage:
    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200
- master:
    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.
- sync:
    Sets the synchronization mode of the various controller within a detector structure
- badChannels:
    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.
- angConv:
    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.
- globalOff:
    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.
- binSize:
    Sets the size of the angular bins for angular conversion.
- threaded:
    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
- detectorDeveloper:
    Detector Developer. (useful to define subset of working functions)
- flatFieldCorrectionFile:
    Flat field corrections file name. Use ‘none’ to disable corrections.
- positions:
    Positions for the acquisition. Usage: n pos1 pos2 … posn
- maximumDetectorSize:
    Maximum detector size
- bitDepth:
    Bit Depth
- exposureTime:
    exposure time value
- exposurePeriod:
    exposure period
- delayAfterTrigger:
    delay after trigger
- numberOfGates:
    Number Of Gates
- numberOfFrames:
    Number Of Frames
- numberOfCycles:
    Number Of Cycles
- timing:
    The timing mode of the detector
- acquisitionTime:
    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.
- triggerPeriod:
    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.
- detectorNumber:
    Returns the serial number of the module (normally the MAC address).
- detectorVersion:
    Returns the version of the controller firmware.
- softwareVersion:
    Returns the version of the software running on the detector.
- thisVersion:
    Returns the version of the control software which is being used.
- pollingInterval:
    The interval for polling the laser front-end for status.
- tempAdc:
    Returns the ADC temperature.
- tempFpga:
    Returns the FPGA temperature.
- detectorMac:
    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.
- rOnline:
    rOnline

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

###### RECEIVER

Instance id: | FXE_ILH_TA/DET/RECEIVER
Class id: | GotthardReceiver
Host: | fxe-rr-sys-con-7
Class documentation:
| GotthardReceiver
Alias: | fxe-rr-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | FXE_ILH_TA/DET/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!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

### EXP

[add component documentation]

#### ONC

[add component documentation]

##### METRO

[add component documentation]

###### USER

#### CHILLER

[add component documentation]

##### DCTRL

[add component documentation]

###### CHILLER_1_REMOTESTART

Instance id: | FXE_EXP_CHILLER/DCTRL/CHILLER_1_REMOTESTART
Class id: | BeckhoffDigitalOutput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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]

###### CHILLER_1_COLLECTIVEALARM

Instance id: | FXE_EXP_CHILLER/SWITCH/CHILLER_1_COLLECTIVEALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_FLOWALARM

Instance id: | FXE_EXP_CHILLER/SWITCH/CHILLER_1_FLOWALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_GUIDEVALUEALARM

Instance id: | FXE_EXP_CHILLER/SWITCH/CHILLER_1_GUIDEVALUEALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_PRESSUREALARM

Instance id: | FXE_EXP_CHILLER/SWITCH/CHILLER_1_PRESSUREALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_TEMPERATUREALARM

Instance id: | FXE_EXP_CHILLER/SWITCH/CHILLER_1_TEMPERATUREALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_1_WATERALARM

Instance id: | FXE_EXP_CHILLER/SWITCH/CHILLER_1_WATERALARM
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-6
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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
- 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.
- invert:
    If set, the digital value as received from the hardware 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

### CRL

[add component documentation]

#### VAC

[add component documentation]

##### VALVE

[add component documentation]

###### GV2

Instance id: | FXE_CRL_VAC/VALVE/GV2
Class id: | BeckhoffValve
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### GV3

Instance id: | FXE_CRL_VAC/VALVE/GV3
Class id: | BeckhoffValve
Host: | fxe-rr-sys-con-3
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-3
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

### CTRL

[add component documentation]

#### TOOLING

[add component documentation]

##### MDL

[add component documentation]

###### BECKHOFF_ASSISTANT

#### VERIFY

[add component documentation]

##### MDL

[add component documentation]

###### ARCHIVE

### DA

[add component documentation]

#### USR

[add component documentation]

##### ZMQ

[add component documentation]

###### BRIDGE_TEST

Instance id: | FXE_DA_USR/ZMQ/BRIDGE_TEST
Class id: | PipeToZeroMQ
Host: | sa1-br-kc-comp-3
Alias: | sa1-br-kc-comp-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-26T13:51:27.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Haufs, Dall’antonia, Michelat
Latest tag: | 3.2.5-2.10.0
Deployment tag: | 3.2.5-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, 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
- 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.5-2.10.0

Created: | 2020-11-26T12:52:59.000Z
Author: | Thomas Michelat
Notes: | Add Karabo 2.10 Versioning Info

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

##### MATCHER

[add component documentation]

###### MATCHER

Instance id: | FXE_DA_USR/MATCHER/MATCHER
Class id: | TrainMatcher
Host: | sa1-br-kc-comp-3
Alias: | sa1-br-kc-comp-3
Git repo: | https://git.xfel.eu/karaboDevices/TrainMatcher
Last modified: | 2021-09-03T19:27:49.175+02:00
Created at: | 2018-04-25T15:34:20.000+02:00
Main authors: | Fabbri, Haufs, Schmidt
Latest tag: | 1.2.0-2.10.2
Deployment tag: | 1.2.0-2.10.2
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- channels:
    list output channel to monitor.
- fastSources:
    Data sources names and configuration from connected output channels
- slowSources:
    Device properties to monitor
- mode:
    operation mode, “match”: match all selected fast sources, “buffer”: send (selected) sources that arrived when the buffer reached the limit
- output:
    Output channel for combined train data.
- received:
    Count how many trains were received.
- sent:
    Count how many train data were sent.
- matchingRatio:
    Exponential moving average of the relation between sent and received trains.
- trainId:
    the last trainId data that matched.
- buffer:
    Length of buffer to hold non-complete trains in.
- delay:
    delay applied before sending data on output channel (in #trains)
- offsetTid:
    If this property is True, it will change the value of the trainId in the metadata for the data sources having an offset value different from 0. The trainId value assigned will be the “matched” trainId, i.e. trainId + offset for the source.

Release History
1.2.0-2.10.2

Created: | 2021-03-26T15:34:34.000+01:00
Author: | Thomas Michelat
Notes: | Add “buffer” mode

1.1.0-2.10.2

Created: | 2021-03-24T14:37:27.000+01:00
Author: | Thomas Michelat
Notes: | option to overwrite trainid in metadata if data source is shifted

1.0.1-2.10.0

Created: | 2020-12-02T17:50:00.000+01:00
Author: | Valerii Bondar
Notes: | Summary: Add Karabo 2.10 Versioning Info

1.0.0-2.7.1

Created: | 2020-02-18T14:21:57.000+01:00
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-27T09:48:16.000+02:00
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-13T16:44:05.000+02:00
Author: | Thomas Michelat
Notes: |

0.2.0b1-2.4.0

Created: | 2019-05-03T15:40:27.000+02:00
Author: | Thomas Michelat
Notes: | simple slow data monitoring, bulked property updates

1.0.0b1-2.4.0

Created: | 2019-03-18T19:50:21.000+01:00
Author: | Ebad Kamil
Notes: | first “real” try of monitoring slow data (will change)

0.1.0-2.4.0

Created: | 2018-04-27T14:01:19.000+02:00
Author: | Thomas Michelat
Notes: |

## SA1

### CTRL

#### NBUNCH

##### DOOCS

###### XRAY_POD

Instance id: | SA1_CTRL_NBUNCH/DOOCS/XRAY_POD
Class id: | DoocsPulseKicker
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.14-2.11.1) does not match tags mentioned in the deployment ([‘1.8.16-2.11.1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- 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
- 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

### RR

#### UTC

##### MDL

###### BUNCH_DECODER

Instance id: | SA1_RR_UTC/MDL/BUNCH_DECODER
Class id: | PulsePatternDecoder
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
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
Installed tag: | 2.0.5-2.11.0
Scenes: | BunchPattern, FXE_RR_SYS/TSYS/BUNCH_DIZITIZER|scene, FXE_RR_SYS/MDL/APD_CFG|scene, FXE_BUNCH_PATTERN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Pulse Pattern Decoder Documentation

The `Pulse Pattern Decoder` device is documented in pulsepatterndecoder:pulsepatterndecoder

Pulse Pattern Decoder Troubleshooting

To troubleshooting documentation

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- input:
    Process the data received from the input channel.

Release History
2.0.5-2.11.0

Created: | 2021-07-23T15:24:27.000+02:00
Author: | Alessandro Silenzi
Notes: | no change in schema

2.0.4-2.10.4

Created: | 2021-05-17T19:36:32.000+02:00
Author: | Alessandro Silenzi
Notes: | Added Laser decoding to the PulsePatternDecoder

2.0.3-2.10.0

Created: | 2020-11-24T13:00:46.000+01:00
Author: | Wajid Ehsan
Notes: | Update Version Info

2.0.2-2.9.6-log-timestamps

Created: | 2020-09-24T14:48:03.000+02:00
Author: | Gabriele Giovanetti
Notes: |

2.0.2-2.9.6

Created: | 2020-09-16T15:50:05.000+02:00
Author: | Gabriele Giovanetti
Notes: | FIX: prevent unwanted task in karabo 2.9 note: can be used also with other karabo versions

2.0.1-2.9.6

Created: | 2020-09-11T14:56:10.000+02:00
Author: | Gabriele Giovanetti
Notes: | Prevent timestamp jumping backwards

2.0.0-2.9.4-hotfix@SPB

Created: | 2020-09-11T14:11:25.000+02:00
Author: | Gabriele Giovanetti
Notes: | Temporary hotfix: bunchpattern table timestamp propagation leads to wrong data in DAQ

2.0.0-2.9.4

Created: | 2020-08-17T14:53:49.000+02:00
Author: | Steffen Hauf
Notes: | Read the patternTable via an input channel

1.5.0-2.7.0-hotfix

Created: | 2020-07-23T18:04:33.000+02:00
Author: | degon
Notes: | hotfix: fire start slot twice for digitizer

1.5.0-2.7.0

Created: | 2020-03-03T12:36:56.000+01:00
Author: | Wajid Ehsan
Notes: | Integration of new device class which facilitates the integration of Bunch pattern integration into Digitizer

1.4.1-2.6.1

Created: | 2019-11-12T14:57:06.000+01:00
Author: | Denys Mamchyk
Notes: | minor fix for updating the status on error

1.4.0-2.6.1

Created: | 2019-10-04T14:14:33.000+00:00
Author: | Valerii Bondar
Notes: | “Proper” deployment tag from ‘master’ branch. Includes OperationChangeNotifier with no prints.

1.4.0-2.6.1-test

Created: | 2019-10-02T18:48:32.000+02:00
Author: | Valerii Bondar
Notes: | Left by Valerii in his rush to the airport, but we need it now. Print statement must be removed

1.3.2-2.5.0-Notifier

Created: | 2019-09-23T13:53:03.000+02:00
Author: | Valerii Bondar
Notes: | This tag is only for tests of OperationChangeNotifier prototype in MID topic. For production deployment use ‘proper’ tag recommended. This tag should be installed only afterwards (with install_device_active.yml) and decommissioned after tests.

1.3.2-2.5.0

Created: | 2019-08-07T17:00:04.000+02:00
Author: | Denys Mamchyk
Notes: | update for rawDelay calculation

1.3.1-2.5.0

Created: | 2019-08-02T17:21:20.000+02:00
Author: | Wajid Ehsan
Notes: | Set pulse Delay

1.3.0-2.5.0

Created: | 2019-07-30T13:43:21.000+02:00
Author: | Cammille Carinan
Notes: | Integration of bunch pattern setting into fastadc device.

1.2.0-2.3.0

Created: | 2019-03-13T19:08:04.000+01:00
Author: | Alessandro Silenzi
Notes: | Using the euxfel_bunch_pattern package

1.1.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | added MainDump node

1.0.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | Main dump is included in the decoding

##### TSYS

###### TIMESERVER

Instance id: | SA1_RR_UTC/TSYS/TIMESERVER
Class id: | TimeServer
Host: | fxe-rr-sys-utc-2
Class documentation:
| TimeServer
Alias: | fxe-rr-sys-utc-2-mch , exflutcafxe-2
Git repo: | https://git.xfel.eu/karaboDevices/timeServer
Last modified: | 2021-09-14T08:39:06.351+02:00
Created at: | 2016-12-02T14:04:29.000+01:00
Main authors: | Hauf, Haufs, Fabbri
Latest tag: | 2.8.1-2.11.1
Deployment tag: | 2.8.1-2.11.1
Installed tag: | 2.8.1-2.11.1
Scenes: | test_fastAdc
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Time Server Documentation

The `Time Server` device is documented in timeServer:timeServer

Time Server Troubleshooting

To troubleshooting documentation

TrainId Workflow and Entities

To Train Id workflow documentation

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- tickFactor:
    The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”
- reset:
    Resets the device in case of an error
- id:
    Most recently published actual trigger ID
- periodActual:
    Most recently published actual period of the ID value increment
- idDiff:
    Difference of ID and its previously published value divided by tick factor
- source:
    Select source of trigger ID as an URI (‘local://internal’, ‘local://x2timer’, or ‘tcp://host:port’)
- devfile:
    Local device file to be used if “local://x2timer” was selected
- periodSet:
    Setpoint for the period of the ID value increment (used only for internally generated ID)
- minPeriod:
    Minimum period value to emit a signal.
- maxPeriod:
    Maximum period value to emit a signal.
- badTrainIdsCounter:
    Counter for non increasing trainId events. Maxes out at 100
- badPeriodsCounter:
    Number of times in a tick factor where the period has been set to 0
- badPeriods:
    Last periods out of bounds
- readBunchPatternTable:
    This flag enables the reading of bunch pattern table. To get the full bunch pattern tables with every train use the ‘Full Bunch Pattern Table Updates’ flag.
- bunchPatternTable:
    Is only output if both the ‘readBunchPatternTable’ and ‘fullBunchPatternUpdates’ flags are set.
- fullBunchPatternUpdates:
    If set to true the full bunch pattern table will be updated for each train and logged.
- outputBunchPattern:
    Output channel to which bunch pattern updates are sent. Bunch patterns are only output if the ‘readBunchPatternTable’ is set.

Release History
2.8.1-2.11.1

Created: | 2021-02-10T16:51:00.000+01:00
Author: | Gabriele Giovanetti
Notes: | ‘update-copied-headers’ into ‘master’

2.8.0-2.10.0

Created: | 2021-02-05T11:41:17.000+01:00
Author: | Gero Flucke
Notes: | Fix bugs on period, C++14, fix CI

2.7.6-2.10.0

Created: | 2020-11-24T08:08:35.000+01:00
Author: | Steffen Hauf
Notes: |

2.7.5-2.9.1

Created: | 2020-09-21T14:07:33.000+02:00
Author: | Alessandro Silenzi
Notes: | Skip ticks with bad periods and added a bunch of instrumentation

2.7.4-2.9.1

Created: | 2020-08-17T11:38:17.000+02:00
Author: | Riccardo Fabbri
Notes: | PatternTable array moved into data node of output channel for DAQ compatibility.

2.7.3-2.9.1

Created: | 2020-07-22T16:18:32.000+02:00
Author: | Riccardo Fabbri
Notes: | Added slot for toggling data processing.

2.7.2-2.9.1

Created: | 2020-07-08T22:40:51.000+02:00
Author: | Riccardo Fabbri
Notes: | PplBunchPatternStats: Node maxBufferLength is reconfigurable.

2.7.1-2.9.1

Created: | 2020-06-26T19:26:19.000+02:00
Author: | Riccardo Fabbri
Notes: | Derive from BunchPattern digest a class with the metrics for PPL bits.

2.7.0-2.9.0

Created: | 2020-05-27T15:47:21.000+02:00
Author: | Steffen Hauf
Notes: |

2.7.0-2.9

Created: | 2020-05-27T15:47:21.000+02:00
Author: | Steffen Hauf
Notes: | Bunch patterns as digests, add a BunchPatternStats device

2.6.0-2.7

Created: | 2020-02-12T15:34:09.000+01:00
Author: | Gero Flucke
Notes: | Introduce average difference of id increase and add alarms to it

2.5.3-2.4.0

Created: | 2019-05-07T16:35:38.000+02:00
Author: | Alessandro Silenzi
Notes: | Avoid System Crashes on multiple instances

2.5.2-2.3.3

Created: | 2019-01-23T10:01:43.000+01:00
Author: | Alessandro Silenzi
Notes: | FEAT: avoid namespace collision with pcLayer

2.5.1-2.3.0

Created: | 2018-12-10T14:26:22.000+01:00
Author: | Alessandro Silenzi
Notes: | added DAQ Policy

2.5.0-2.2.6

Created: | 2018-11-29T16:54:33.000+01:00
Author: | Alessandro Silenzi
Notes: | Added read Bunch Pattern table feature

2.4.0-2.1.15

Created: | 2018-02-27T11:18:55.000+01:00
Author: | Gero Flucke
Notes: | Publish signalled trainIds to data logger

2.3.2-2.1.15

Created: | 2017-09-14T15:41:19.000+02:00
Author: | Sergey Esenov
Notes: | Fix SIGFPE in signalHandler

2.3.1-2.1.15

Created: | 2017-08-25T10:54:38.000+02:00
Author: | Sergey Esenov
Notes: | Use timing from timing board with the following priority: ‘master’, ‘global’ or ‘board’ to avoid zero values.

2.3.0-2.1.15

Created: | 2017-08-20T14:55:53.000+02:00
Author: | Sergey Esenov
Notes: |

2.2.0-2.1.12

Created: | 2017-06-12T15:43:27.000+02:00
Author: | esenov
Notes: |

### XTD2

#### XGM

##### DOOCS

###### MAIN

Instance id: | SA1_XTD2_XGM/DOOCS/MAIN
Class id: | DoocsXGM
Host: | fxe-rr-sys-con-6
Alias: | fxe-rr-sys-con-6
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.14-2.11.1
Scenes: | SA1_XTD2_XGM, test_Scene, SA1_XTD2_XGM, SA1_XTD2_XGM, scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.14-2.11.1) does not match tags mentioned in the deployment ([‘1.8.16-2.11.1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- 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
- 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

#### ATT

[add component documentation]

##### MDL

[add component documentation]

###### MAIN

#### CRL

[add component documentation]

##### MDL

[add component documentation]

###### CRL

Instance id: | SA1_XTD2_CRL/MDL/CRL
Class id: | CompoundRefractiveLens
Host: | fxe-rr-sys-con-13
Alias: | fxe-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
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
- numRods:
    Turn on/off Rods of CRL
- photonEnergy:
    Device Id to read Photon Energy value
- wavelength:
    Wave Length
- positionTolerance:
    Position tolerance to identify material foils
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an lens setting was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current lens setting and target is automaticallyrefreshed.
- mode:
    Safe mode or Normal mode
- desiredFocalLength:
    Provide a desired FocalLength
- availableScenes:
    Scenes from the Slit System
- interlocks:
    Properties of the interlock sensors.

Release History
1.3.0-2.11.0

Created: | 2021-05-27T15:25:24.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.4-2.10.0

Created: | 2021-05-26T15:39:43.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor use EPS logic

1.2.3-2.10.0

Created: | 2020-11-23T18:18:18.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.3-2.7.2

Created: | 2020-02-26T17:04:07.000+01:00
Author: | Robert Schaffer
Notes: | Fixed a case typo

1.2.2-2.7.2-test

Created: | 2020-02-26T15:04:45.000+01:00
Author: | Robert Schaffer
Notes: | To be tested at MID tunnel, and improved upon.

1.2.2-2.7.2

Created: | 2020-02-26T13:21:31.000+01:00
Author: | Robert Schaffer
Notes: | Uses interlocks for retracted positions, and allows movement commands while arms are in motion.

1.2.1-2.7.0-test

Created: | 2020-01-21T16:08:12.000+01:00
Author: | Robert Schaffer
Notes: | A tagged branch to be tested in XTD6. This allows local saving of parameters.

1.2.1-2.7.0

Created: | 2019-12-23T14:50:06.000+01:00
Author: | Wajid Ehsan
Notes: | Fix actual energy setter

1.2.0-2.7.0

Created: | 2019-12-13T11:54:51.000+01:00
Author: | Robert Schaffer
Notes: |

1.1.1-2.2.4-hotfix

Created: | 2018-10-08T22:49:17.000+02:00
Author: | MScholz
Notes: | Configuration of rods

1.1.1-2.2.4

Created: | 2018-07-20T11:58:18.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor Scene

1.1.0-2.2.4

Created: | 2018-06-13T16:56:11.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.3

Created: | 2018-05-31T13:46:49.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.3

Created: | 2018-05-31T13:28:02.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.14

Created: | 2017-08-18T20:01:36.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.14

Created: | 2017-08-18T16:52:56.000+02:00
Author: | Dennis Goeries
Notes: |

### XTD9

#### SYS

##### SWITCH

###### C11804M_T1OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11804M_T1OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11804M_T2OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11804M_T2OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11804M_T3BALOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11804M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11804M_T3REDOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11804M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11805M_T1OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11805M_T1OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11805M_T2OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11805M_T2OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11805M_T3BALOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11805M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11805M_T3REDOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11805M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11806M_T1OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11806M_T1OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11806M_T2OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11806M_T2OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11806M_T3BALOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11806M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11806M_T3REDOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11806M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11807M_T1OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11807M_T1OK
Class id: | BeckhoffDigitalInput
Host: | exflcon54n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware 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.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: |

###### C11807M_T2OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11807M_T2OK
Class id: | BeckhoffDigitalInput
Host: | exflcon54n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware 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.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: |

###### C11807M_T3BALOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11807M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | exflcon54n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware 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.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: |

###### C11807M_T3REDOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11807M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | exflcon54n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
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
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware 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.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: |

###### C11808M_T1OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11808M_T1OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11808M_T2OK

Instance id: | SA1_XTD9_SYS/SWITCH/C11808M_T2OK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11808M_T3BALOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11808M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### C11808M_T3REDOK

Instance id: | SA1_XTD9_SYS/SWITCH/C11808M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | fxe-br-sys-con-12
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-br-sys-con-12
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

#### VAC

##### SWITCH

###### P12290I_on_setpoint

Instance id: | SA1_XTD9_VAC/SWITCH/P12290I_on_setpoint
Class id: | BeckhoffDigitalInput
Host: | exflcon07n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-07-07T10:56:42.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: | VACUUM_OVERVIEW, FXE_RR_SYS/ILOCK/MAIN|Global interlock, VAC-SIGNALS, VAC-SIGNALS, FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    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.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- resetCounter:
    Reset count of edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.

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.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.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

###### VALVE_V12090M_open_FXE

Instance id: | SA1_XTD9_VAC/SWITCH/VALVE_V12090M_open_FXE
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | VACUUM_OVERVIEW, INTERLOCK_SIGNALS, VAC-SIGNALS, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK, FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### P12290I_ON_SETPOINT

Instance id: | SA1_XTD9_VAC/SWITCH/P12290I_ON_SETPOINT
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | VACUUM_OVERVIEW, VAC-SIGNALS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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_V12090M_OPEN_FXE

Instance id: | SA1_XTD9_VAC/SWITCH/VALVE_V12090M_OPEN_FXE
Class id: | BeckhoffDigitalInput
Host: | fxe-rr-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | fxe-rr-sys-con-1 , fxe-rr-sys-con-14 , fxe-rr-sys-con-10 , fxe-rr-sys-con-11 , fxe-rr-sys-con-13
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-02T19:55:31.151+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | VAC-SIGNALS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

### SRP

[add component documentation]

#### AIBS

[add component documentation]

##### AIBS

[add component documentation]

###### FXE_AIBS

## Non-standard installations

BeckhoffAnalogOutput:
| affected devices: FXE_AUXT_AIO/ACTRL/OUT3, FXE_AUXT_AIO/ACTRL/OUT4, FXE_AUXT_AIO/ACTRL/OUT5, FXE_AUXT_AIO/ACTRL/OUT6, FXE_AUXT_AIO/ACTRL/OUT7, FXE_AUXT_AIO/ACTRL/OUT8, FXE_AUXT_AIO/ACTRL/OUT_HV_USET_, FXE_AUXT_AIO/ACTRL/OUT_LLS3_SETPOINT installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffAnalogInput:
| affected devices: FXE_AUXT_AIO/ASENS/IN4, FXE_AUXT_AIO/ASENS/IN5, FXE_AUXT_AIO/ASENS/IN6, FXE_AUXT_AIO/ASENS/IN7, FXE_AUXT_AIO/ASENS/IN8, FXE_AUXT_AIO/ASENS/IN_HV_IREAD_, FXE_AUXT_AIO/ASENS/IN_HV_UREAD_, FXE_AUXT_AIO/ASENS/IN_LPM, FXE_AUXT_AIO/ASENS/SPARE1, FXE_AUXT_AIO/ASENS/SPARE2, FXE_AUXT_AIO/ASENS/SPARE3, FXE_OGT1_ATT/TSENS/B4C_TEMP1, FXE_OGT1_ATT/TSENS/B4C_TEMP2, FXE_OGT1_ATT/TSENS/ROD1_TEMP1, FXE_OGT1_ATT/TSENS/ROD1_TEMP2, FXE_OGT1_ATT/TSENS/ROD2_TEMP1, FXE_OGT1_ATT/TSENS/ROD2_TEMP2, FXE_OGT1_ATT/TSENS/ROD3_TEMP1, FXE_OGT1_ATT/TSENS/ROD3_TEMP2, FXE_OGT1_ATT/TSENS/ROD4_TEMP1, FXE_OGT1_ATT/TSENS/ROD4_TEMP2, FXE_OGT1_TAD/TSENS/B4C_TEMP1, FXE_OGT1_TAD/TSENS/B4C_TEMP2, FXE_OGT1_TAD/TSENS/FOIL_TEMP1, FXE_OGT1_TAD/TSENS/FOIL_TEMP2, FXE_OGT2_BIU-1/TSENS/ROD_TEMP1, FXE_OGT2_BIU-1/TSENS/ROD_TEMP2, FXE_OGT2_VAC/GAUGE/CRL_CC, FXE_OGT2_VAC/GAUGE/DW_FR, FXE_OGT2_VAC/GAUGE/FV_ANAOUTPRESSURE1, FXE_OGT2_VAC/GAUGE/FV_ANAOUTPRESSURE2, FXE_OGT2_VAC/GAUGE/PSLIT2_FR installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalOutput:
| affected devices: FXE_AUXT_AIO/DCTRL/VSET_VMON_, FXE_OGT2_VAC/DCTRL/CRL_CC, FXE_OGT2_VAC/DCTRL/FV_CLOSEINPUTEXTERNAL, FXE_OGT2_VAC/DCTRL/FV_INPUTCLOSE, FXE_OGT2_VAC/DCTRL/FV_INPUTEXTSIGNAL1, FXE_OGT2_VAC/DCTRL/FV_INPUTEXTSIGNAL2, FXE_OGT2_VAC/DCTRL/FV_INPUTINTERLOCKCLOSE, FXE_OGT2_VAC/DCTRL/FV_INPUTINTERLOCKOPEN, FXE_OGT2_VAC/DCTRL/FV_INPUTOPEN, FXE_OGT2_VAC/DCTRL/FV_INPUTSENSOROFF1, FXE_OGT2_VAC/DCTRL/FV_INPUTSENSOROFF2, FXE_OGT2_VAC/DCTRL/FV_INPUTSYSTEMRESET, FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_STATE, FXE_OGT2_VAC/DCTRL/FV_OUTPUTOPEN_STATE, FXE_OGT2_VAC/DCTRL/GV_OPEN, FXE_OGT2_VAC/DCTRL/INTERLOCK_ACTIV, FXE_OGT2_VAC/DCTRL/INTERLOCK_BRIDGED installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
JJAttenuator: | affected devices: FXE_OGT1_ATT/MDL/MAIN installed at: None installation not in a standard path
BeckhoffDigitalInput:
| affected devices: FXE_OGT1_VAC/SWITCH/ATT_IP75_ON_SETPOINT, FXE_OGT1_VAC/SWITCH/PSLIT1_FR_VALUE, FXE_OGT1_VAC/SWITCH/PSLIT1_IP150_ON_SETPOINT, FXE_OGT2_VAC/SWITCH/FV_CLOSEOUTPUTEXTERNAL, FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE, FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSH1, FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSH2, FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSHEXTSIGNAL1, FXE_OGT2_VAC/SWITCH/FV_OUTPUTINRUSHEXTSIGNAL2, FXE_OGT2_VAC/SWITCH/FV_OUTPUTOPEN, FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY, FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY1, FXE_OGT2_VAC/SWITCH/FV_OUTPUTREADY2, FXE_OGT2_VAC/SWITCH/FV_OUTPUTSYSTEM_READY, FXE_OGT2_VAC/SWITCH/INTERLOCK_KEY_NC, FXE_OGT2_VAC/SWITCH/INTERLOCK_KEY_NO, FXE_OGT2_VAC/SWITCH/PRESSURE_SENSOR installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeamImagingUnit:
| affected devices: FXE_OGT2_BIU-1/MDL/MAIN installed at: None installation not in a standard path
BeckhoffAgilentIonPump:
| affected devices: FXE_OGT2_VAC/2, FXE_OGT2_VAC/3, FXE_OGT2_VAC/ICTRL/PUMP_CTL, FXE_OGT2_VAC/ICTRL/PUMP_CTL150, FXE_OGT2_VAC/IPUMP/CRL_IP55, FXE_OGT2_VAC/IPUMP/DW_IP75, FXE_OGT2_VAC/IPUMP/PSLIT2_IP150 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
ConditionValve: | affected devices: FXE_OGT2_VAC/VALVE/COND_GV installed at: None installation not in a standard path
BeckhoffValve: | affected devices: FXE_OGT2_VAC/VALVE/GV installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
SlsCalibrator: | affected devices: FXE_OGT3_PAM/CAL/CONTROL_REF installed at: None installation not in a standard path
GotthardReceiver:
| affected devices: FXE_OGT3_PAM/DET/RECEIVER_REF installed at: None installation not in a standard path
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/2 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/2_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
SlitSystem: | affected devices: FXE_AUXT_CSLIT/MDL/MAIN installed at: None installation not in a standard path
BeamPositionMonitor:
| affected devices: FXE_AUXT_DWI0/MDL/MONITOR, FXE_OGT1_IPM/MDL/MONITOR, FXE_OGT3_IPM/MDL/MONITOR installed at: None installation not in a standard path
BeamImagingUnit:
| affected devices: FXE_OGT2_BIU-2/MDL/MAIN installed at: None installation not in a standard path
BeckhoffAnalogInput:
| affected devices: FXE_OGT2_BIU-2/TSENS/ROD_TEMP1, FXE_OGT2_BIU-2/TSENS/ROD_TEMP2 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/4 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/4_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
DoocsPhaseshifter:
| affected devices: FXE_AUXT_LIC/DOOCS/PPLASER, FXE_AUXT_LIC/DOOCS/TANGERINE installed at: /scratch/xctrl/karabo/plugins/libdoocsDevices.so not the deployed tag: 1.8.14-2.11.1 not in [‘1.8.16-2.11.1’]
DoocsOpticalDelay:
| affected devices: FXE_AUXT_LIC/DOOCS/PPODL installed at: /scratch/xctrl/karabo/plugins/libdoocsDevices.so not the deployed tag: 1.8.14-2.11.1 not in [‘1.8.16-2.11.1’]
BeckhoffDigitalOutput:
| affected devices: FXE_EXP_CHILLER/DCTRL/CHILLER_1_REMOTESTART, FXE_ILH_CHILLER/DCTRL/CHILLER_1_REMOTESTART, FXE_ILH_CHILLER/DCTRL/CHILLER_2_REMOTESTART installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalInput:
| affected devices: FXE_EXP_CHILLER/SWITCH/CHILLER_1_COLLECTIVEALARM, FXE_EXP_CHILLER/SWITCH/CHILLER_1_FLOWALARM, FXE_EXP_CHILLER/SWITCH/CHILLER_1_GUIDEVALUEALARM, FXE_EXP_CHILLER/SWITCH/CHILLER_1_PRESSUREALARM, FXE_EXP_CHILLER/SWITCH/CHILLER_1_TEMPERATUREALARM, FXE_EXP_CHILLER/SWITCH/CHILLER_1_WATERALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_1_COLLECTIVEALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_1_FLOWALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_1_GUIDEVALUEALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_1_PRESSUREALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_1_TEMPERATUREALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_1_WATERALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_2_COLLECTIVEALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_2_FLOWALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_2_GUIDEVALUEALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_2_PRESSUREALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_2_TEMPERATUREALARM, FXE_ILH_CHILLER/SWITCH/CHILLER_2_WATERALARM installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffMC2Base:
| affected devices: FXE_PPL_LAS/MOTOR/STAGE_1 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/6 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/6_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
X2Timer: | affected devices: FXE_RR_SYS/TSYS/UTC-1-S2, FXE_RR_SYS/TSYS/UTC-1-S3, FXE_RR_SYS/TSYS/UTC-2-S2, FXE_RR_SYS/TSYS/UTC-2-S3 installed at: /scratch/xctrl/karabo/plugins/libdoocsDevices.so not the deployed tag: 1.8.14-2.11.1 not in [‘1.8.16-2.11.1’]
DoocsPulseKicker:
| affected devices: SA1_CTRL_NBUNCH/DOOCS/XRAY_POD installed at: /scratch/xctrl/karabo/plugins/libdoocsDevices.so not the deployed tag: 1.8.14-2.11.1 not in [‘1.8.16-2.11.1’]
DoocsXGM: | affected devices: SA1_XTD2_XGM/DOOCS/MAIN, SPB_XTD9_XGM/DOOCS/MAIN installed at: /scratch/xctrl/karabo/plugins/libdoocsDevices.so not the deployed tag: 1.8.14-2.11.1 not in [‘1.8.16-2.11.1’]
PplMultiSubPattern:
| affected devices: FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN installed at: /scratch/xctrl/karabo/extern/lib/python3.6/site-packages/PplPattern.egg-link is a development install might be hot-fixed, dt=56 days, 14:58:00 not the deployed tag: 1.5.6-2.10.0 not in [‘1.6.0-2.11.0’]
BeckhoffMonitor:
| affected devices: FXE_BR_SYS/MON/PLC_12 installed at: None installation not in a standard path
BeckhoffCom: | affected devices: FXE_BR_SYS/PLC/12 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_BR_SYS/PLC/12_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
DoocsUndulatorEnergy:
| affected devices: FXE_XTD2_UND/DOOCS/ENERGY installed at: /scratch/xctrl/karabo/plugins/libdoocsDevices.so not the deployed tag: 1.8.14-2.11.1 not in [‘1.8.16-2.11.1’]
BeckhoffDigitalOutput:
| affected devices: FXE_XTD9_DG/DCTRL/APERTURE_CYLINDER, FXE_XTD9_DG/DCTRL/LIGHT_CAMERA, FXE_XTD9_MONO-1/DCTRL/CAM_POWER, FXE_XTD9_MONO-1/DCTRL/CRYO_POWER, FXE_XTD9_MONO-1/DCTRL/CRYO_POWER_2VAC, FXE_XTD9_MONO-1/DCTRL/HT1_ENABLE, FXE_XTD9_MONO-1/DCTRL/HT1_REM_SEL, FXE_XTD9_MONO-1/DCTRL/HT2_ENABLE, FXE_XTD9_MONO-1/DCTRL/HT2_REM_SEL, FXE_XTD9_MONO-1/DCTRL/HT3_ENABLE, FXE_XTD9_MONO-1/DCTRL/HT3_REM_SEL, FXE_XTD9_MONO-1/DCTRL/LED_POWER, FXE_XTD9_MONO-1/DCTRL/TOP_XTAL_ROLL_LIDLE, FXE_XTD9_MONO-1/DCTRL/TOP_XTAL_ROLL_SWITCH, FXE_XTD9_MONO-1/DCTRL/TOP_XTAL_RPITCH_LIDLE, FXE_XTD9_MONO-1/DCTRL/TOP_XTAL_RPITCH_SWITCH, FXE_XTD9_MONO-2/DCTRL/CAM_POWER, FXE_XTD9_MONO-2/DCTRL/CRYO_POWER, FXE_XTD9_MONO-2/DCTRL/CRYO_POWER_2VAC, FXE_XTD9_MONO-2/DCTRL/HT1_ENABLE, FXE_XTD9_MONO-2/DCTRL/HT1_REM_SEL, FXE_XTD9_MONO-2/DCTRL/HT2_ENABLE, FXE_XTD9_MONO-2/DCTRL/HT2_REM_SEL, FXE_XTD9_MONO-2/DCTRL/HT3_ENABLE, FXE_XTD9_MONO-2/DCTRL/HT3_REM_SEL, FXE_XTD9_MONO-2/DCTRL/LED_POWER, FXE_XTD9_MONO-2/DCTRL/TOP_XTAL_ROLL_LIDLE, FXE_XTD9_MONO-2/DCTRL/TOP_XTAL_ROLL_SWITCH, FXE_XTD9_MONO-2/DCTRL/TOP_XTAL_RPITCH_LIDLE, FXE_XTD9_MONO-2/DCTRL/TOP_XTAL_RPITCH_SWITCH installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffEncoder:
| affected devices: FXE_XTD9_DG/ENC/X_ROLL, FXE_XTD9_DG/ENC/X_TRANS, FXE_XTD9_DG/ENC/Y_TRANS, FXE_XTD9_MONO-1/ENC/ACCM_PITCH, FXE_XTD9_MONO-1/ENC/TX, FXE_XTD9_MONO-1/ENC/TY, FXE_XTD9_MONO-2/ENC/ACCM_PITCH, FXE_XTD9_MONO-2/ENC/TX, FXE_XTD9_MONO-2/ENC/TY installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeamImagingUnit:
| affected devices: FXE_XTD9_DG/MDL/INOUTX, FXE_XTD9_MONO-1/MDL/INOUTX, FXE_XTD9_MONO-1/MDL/INOUTY, FXE_XTD9_MONO-2/MDL/INOUTX, FXE_XTD9_MONO-2/MDL/INOUTY installed at: None installation not in a standard path
BeckhoffSimpleMotor:
| affected devices: FXE_XTD9_DG/MOTOR/X_ROLL, FXE_XTD9_DG/MOTOR/X_TRANS, FXE_XTD9_DG/MOTOR/Y_TRANS, FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH, FXE_XTD9_MONO-1/MOTOR/TX, FXE_XTD9_MONO-1/MOTOR/TY, FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH, FXE_XTD9_MONO-2/MOTOR/TX, FXE_XTD9_MONO-2/MOTOR/TY installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffAnalogOutput:
| affected devices: FXE_XTD9_MONO-1/ACTRL/HT1_I_PROG, FXE_XTD9_MONO-1/ACTRL/HT1_V_PROG, FXE_XTD9_MONO-1/ACTRL/HT2_I_PROG, FXE_XTD9_MONO-1/ACTRL/HT2_V_PROG, FXE_XTD9_MONO-1/ACTRL/HT3_I_PROG, FXE_XTD9_MONO-1/ACTRL/HT3_V_PROG, FXE_XTD9_MONO-1/ACTRL/TOP_XTAL_FPITCH, FXE_XTD9_MONO-2/ACTRL/HT1_I_PROG, FXE_XTD9_MONO-2/ACTRL/HT1_V_PROG, FXE_XTD9_MONO-2/ACTRL/HT2_I_PROG, FXE_XTD9_MONO-2/ACTRL/HT2_V_PROG, FXE_XTD9_MONO-2/ACTRL/HT3_I_PROG, FXE_XTD9_MONO-2/ACTRL/HT3_V_PROG, FXE_XTD9_MONO-2/ACTRL/TOP_XTAL_FPITCH installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffAnalogInput:
| affected devices: FXE_XTD9_MONO-1/ASENS/HT1_I_MON, FXE_XTD9_MONO-1/ASENS/HT1_V_MON, FXE_XTD9_MONO-1/ASENS/HT2_I_MON, FXE_XTD9_MONO-1/ASENS/HT2_V_MON, FXE_XTD9_MONO-1/ASENS/HT3_I_MON, FXE_XTD9_MONO-1/ASENS/HT3_V_MON, FXE_XTD9_MONO-1/ASENS/TOP_XTAL_FPITCH, FXE_XTD9_MONO-1/ASENS/TOP_XTAL_ROLL, FXE_XTD9_MONO-1/ASENS/TOP_XTAL_RPITCH, FXE_XTD9_MONO-1/TSENS/T0, FXE_XTD9_MONO-1/TSENS/T1, FXE_XTD9_MONO-1/TSENS/T2, FXE_XTD9_MONO-2/ASENS/HT1_I_MON, FXE_XTD9_MONO-2/ASENS/HT1_V_MON, FXE_XTD9_MONO-2/ASENS/HT2_I_MON, FXE_XTD9_MONO-2/ASENS/HT2_V_MON, FXE_XTD9_MONO-2/ASENS/HT3_I_MON, FXE_XTD9_MONO-2/ASENS/HT3_V_MON, FXE_XTD9_MONO-2/ASENS/TOP_XTAL_FPITCH, FXE_XTD9_MONO-2/ASENS/TOP_XTAL_ROLL, FXE_XTD9_MONO-2/ASENS/TOP_XTAL_RPITCH, FXE_XTD9_MONO-2/TSENS/T0, FXE_XTD9_MONO-2/TSENS/T1, FXE_XTD9_MONO-2/TSENS/T2 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
MonoChromator: | affected devices: FXE_XTD9_MONO-1/MDL/ACCM_PITCH, FXE_XTD9_MONO-2/MDL/ACCM_PITCH installed at: None installation not in a standard path
BeckhoffMC2Base:
| affected devices: FXE_XTD9_MONO-1/MOTOR/TOP_XTAL_ROLL, FXE_XTD9_MONO-1/MOTOR/TOP_XTAL_RPITCH, FXE_XTD9_MONO-2/MOTOR/TOP_XTAL_ROLL, FXE_XTD9_MONO-2/MOTOR/TOP_XTAL_RPITCH installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalInput:
| affected devices: FXE_XTD9_MONO-1/SWITCH/HT1_IS_LOC, FXE_XTD9_MONO-1/SWITCH/HT2_IS_LOC, FXE_XTD9_MONO-1/SWITCH/HT3_IS_LOC, FXE_XTD9_MONO-1/SWITCH/TOP_XTAL_ROLL_LFAULT, FXE_XTD9_MONO-1/SWITCH/TOP_XTAL_RPITCH_LFAULT, FXE_XTD9_MONO-2/SWITCH/HT1_IS_LOC, FXE_XTD9_MONO-2/SWITCH/HT2_IS_LOC, FXE_XTD9_MONO-2/SWITCH/HT3_IS_LOC, FXE_XTD9_MONO-2/SWITCH/TOP_XTAL_ROLL_LFAULT, FXE_XTD9_MONO-2/SWITCH/TOP_XTAL_RPITCH_LFAULT, FXE_XTD9_MONO/SWITCH/VAC_OK, SA1_XTD9_SYS/SWITCH/C11804M_T1OK, SA1_XTD9_SYS/SWITCH/C11804M_T2OK, SA1_XTD9_SYS/SWITCH/C11804M_T3BALOK, SA1_XTD9_SYS/SWITCH/C11804M_T3REDOK, SA1_XTD9_SYS/SWITCH/C11805M_T1OK, SA1_XTD9_SYS/SWITCH/C11805M_T2OK, SA1_XTD9_SYS/SWITCH/C11805M_T3BALOK, SA1_XTD9_SYS/SWITCH/C11805M_T3REDOK, SA1_XTD9_SYS/SWITCH/C11806M_T1OK, SA1_XTD9_SYS/SWITCH/C11806M_T2OK, SA1_XTD9_SYS/SWITCH/C11806M_T3BALOK, SA1_XTD9_SYS/SWITCH/C11806M_T3REDOK, SA1_XTD9_SYS/SWITCH/C11808M_T1OK, SA1_XTD9_SYS/SWITCH/C11808M_T2OK, SA1_XTD9_SYS/SWITCH/C11808M_T3BALOK, SA1_XTD9_SYS/SWITCH/C11808M_T3REDOK installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
MonoChromatorGroup:
| affected devices: FXE_XTD9_MONO/MDL/ACCM_PITCH installed at: None installation not in a standard path
BeckhoffValve: | affected devices: FXE_CRL_VAC/VALVE/GV2, FXE_CRL_VAC/VALVE/GV3 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
CompoundRefractiveLens:
| affected devices: FXE_OGT2_CRL/MDL/MAIN installed at: None installation not in a standard path
BeckhoffAnalogInput:
| affected devices: FXE_OGT2_CRL/TSENS/LENS10_T1, FXE_OGT2_CRL/TSENS/LENS10_T2, FXE_OGT2_CRL/TSENS/LENS1_T1, FXE_OGT2_CRL/TSENS/LENS1_T2, FXE_OGT2_CRL/TSENS/LENS2_T1, FXE_OGT2_CRL/TSENS/LENS2_T2, FXE_OGT2_CRL/TSENS/LENS3_T1, FXE_OGT2_CRL/TSENS/LENS3_T2, FXE_OGT2_CRL/TSENS/LENS4_T1, FXE_OGT2_CRL/TSENS/LENS4_T2, FXE_OGT2_CRL/TSENS/LENS5_T1, FXE_OGT2_CRL/TSENS/LENS5_T2, FXE_OGT2_CRL/TSENS/LENS6_T1, FXE_OGT2_CRL/TSENS/LENS6_T2, FXE_OGT2_CRL/TSENS/LENS7_T1, FXE_OGT2_CRL/TSENS/LENS7_T2, FXE_OGT2_CRL/TSENS/LENS8_T1, FXE_OGT2_CRL/TSENS/LENS8_T2, FXE_OGT2_CRL/TSENS/LENS9_T1, FXE_OGT2_CRL/TSENS/LENS9_T2, FXE_OGT2_PSLIT/TSENS/BLADE1_TEMP1, FXE_OGT2_PSLIT/TSENS/BLADE1_TEMP2, FXE_OGT2_PSLIT/TSENS/BLADE2_TEMP1, FXE_OGT2_PSLIT/TSENS/BLADE2_TEMP2, FXE_OGT2_PSLIT/TSENS/BLADE3_TEMP1, FXE_OGT2_PSLIT/TSENS/BLADE3_TEMP2, FXE_OGT2_PSLIT/TSENS/BLADE4_TEMP1, FXE_OGT2_PSLIT/TSENS/BLADE4_TEMP2 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
SlitSystem: | affected devices: FXE_OGT2_PSLIT/MDL/MAIN installed at: None installation not in a standard path
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/3 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/3_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DAQ_DATA/DA/1, FXE_DAQ_DATA/DA/3, FXE_DAQ_DATA/LPD1MCTRL/0, FXE_DAQ_DATA/LPD1MCTRL/1

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DAQ_DATA/DA/2, FXE_DAQ_DATA/DA/4

Host could not be accessed

Affected classes:
| RunConfigurator, DataManager, MetadataDBRemote, RunController
Affected devices:
| FXE_DAQ_DATA/DM/CONFIGURATOR, FXE_DAQ_DATA/DM/DATA_MANAGER, FXE_DAQ_DATA/DM/MDC_REMOTE, FXE_DAQ_DATA/DM/RUN_CONTROL

Host could not be accessed

Affected classes:
| ReportConfigGroups, RunConfigurationGroup, CheckConfigGroups
Affected devices:
| FXE_DAQ_DATA/DM/DSG_REPORT_1, FXE_DAQ_DATA/DM/FEM_MDL_LPD_GROUP, FXE_DAQ_DATA/DM/FXE_AUXT_AIO_GROUP, FXE_DAQ_DATA/DM/FXE_AUXT_CSLIT_GROUP, FXE_DAQ_DATA/DM/FXE_AUXT_LIC_GROUP, FXE_DAQ_DATA/DM/FXE_DET_LPD1M-1_GROUP, FXE_DAQ_DATA/DM/FXE_DET_MOV_GROUP, FXE_DAQ_DATA/DM/FXE_DOC_ADHOC_GROUP, FXE_DAQ_DATA/DM/FXE_DOOCS_BAMS_GROUP, FXE_DAQ_DATA/DM/FXE_ENERGY_GROUP, FXE_DAQ_DATA/DM/FXE_ILH_TA_GOTTHARD_GROUP, FXE_DAQ_DATA/DM/FXE_MONO_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_ATT_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_BIU_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_IPM_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_MOV_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_PSLIT_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_SA_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_TAD_CAM_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_TAD_GOTTHARD1_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_TAD_GROUP, FXE_DAQ_DATA/DM/FXE_OGT1_VAC_GROUP, FXE_DAQ_DATA/DM/FXE_OGT2_BIU-1_GROUP, FXE_DAQ_DATA/DM/FXE_OGT2_BIU-2_GROUP, FXE_DAQ_DATA/DM/FXE_OGT2_CRL_GROUP, FXE_DAQ_DATA/DM/FXE_OGT2_CRL_LENS_GROUP, FXE_DAQ_DATA/DM/FXE_OGT2_MOV_GROUP, FXE_DAQ_DATA/DM/FXE_OGT2_PSLIT_GROUP, FXE_DAQ_DATA/DM/FXE_OGT2_VAC_GROUP, FXE_DAQ_DATA/DM/FXE_OGT3_BIU_GROUP, FXE_DAQ_DATA/DM/FXE_OGT3_IPM_GROUP, FXE_DAQ_DATA/DM/FXE_OGT3_MOV_GROUP, FXE_DAQ_DATA/DM/FXE_OGT3_SA_GROUP, FXE_DAQ_DATA/DM/FXE_OGT3_XGMD_GROUP, FXE_DAQ_DATA/DM/FXE_PPL_LAS_GROUP, FXE_DAQ_DATA/DM/FXE_PPL_TRG_GROUP, FXE_DAQ_DATA/DM/FXE_RR_SYS_DIGI_GROUP, FXE_DAQ_DATA/DM/FXE_SA1_OPTICS_GROUP, FXE_DAQ_DATA/DM/FXE_SCAN_GROUP, FXE_DAQ_DATA/DM/FXE_SMS_CAM_GROUP, FXE_DAQ_DATA/DM/FXE_SMS_JSS_GROUP, FXE_DAQ_DATA/DM/FXE_SMS_MIC_GROUP, FXE_DAQ_DATA/DM/FXE_SMS_MOV_GROUP, FXE_DAQ_DATA/DM/FXE_SMS_USR_ALL_GROUP, FXE_DAQ_DATA/DM/FXE_SMS_USR_GROUP, FXE_DAQ_DATA/DM/FXE_SMS_VHS_GROUP, FXE_DAQ_DATA/DM/FXE_SMS_XEY_GROUP, FXE_DAQ_DATA/DM/FXE_SYS_VAC2MPS_GROUP, FXE_DAQ_DATA/DM/FXE_X2TIMER_GROUP, FXE_DAQ_DATA/DM/FXE_XAD_JF1M_1_GROUP, FXE_DAQ_DATA/DM/FXE_XAD_JF1M_2_GROUP, FXE_DAQ_DATA/DM/FXE_XAD_JF1M_CTRL_GROUP, FXE_DAQ_DATA/DM/FXE_XAD_JF500K_CTRL_GROUP, FXE_DAQ_DATA/DM/FXE_XAD_JF500K_GROUP, FXE_DAQ_DATA/DM/LPD1M-1_XTDF_GROUP, FXE_DAQ_DATA/DM/OGT1_GOTTHARD_GROUP, FXE_DAQ_DATA/DM/OGT3_GOTTHARD_GROUP, FXE_DAQ_DATA/DM/SCAN_GROUP, FXE_DAQ_DATA/DM/TEST_DOOCS_GROUP, FXE_DAQ_DATA/DM/checkConfigGroups

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DAQ_DATA/DOC/1, FXE_DAQ_DATA/JNGFR/1, FXE_DAQ_DATA/JNGFR/2, FXE_DAQ_DATA/JNGFR/3, FXE_DAQ_DATA/JNGFRCTRL/0
Karabacon: | affected devices: FXE_DAQ_SCAN/MDL/KARABACON installed at: /scratch/xctrl/karabo/extern/lib/python3.6/site-packages/karabacon not the deployed tag: 2.4.5-2.11.1 not in [‘2.4.6-2.11.1’]
TrainMatcher: | affected devices: FXE_DA_USR/MATCHER/MATCHER, FXE_DET_LPD1M-1/TRAINMATCHER/LPD_NORM installed at: None installation not in a standard path
PipeToZeroMQ: | affected devices: FXE_DA_USR/ZMQ/BRIDGE, FXE_DET_LPD1M-1/ZMQ/APPEND_CORR, FXE_XAD_JF1M/ZMQ/APPEND, FXE_XAD_JF500K/ZMQ/CORR_GAIN installed at: None installation not in a standard path
CppFemCombiner: | affected devices: FXE_DET_LPD1M-1/CAL/APPEND_CORRECTED installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CppFemSplitter: | affected devices: FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q1M3, FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q3M3 installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CppFemCombiner: | affected devices: FXE_DET_LPD1M-1/CAL/APPEND_RAW installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CppFemSplitter: | affected devices: FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q1M2, FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q3M2 installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CppFemCombiner: | affected devices: FXE_DET_LPD1M-1/CAL/APPEND_RAW_GAIN installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CppFemSplitter: | affected devices: FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q1M4, FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q3M4 installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CalManager: | affected devices: FXE_DET_LPD1M-1/CAL/CAL_MANAGER installed at: /scratch/xctrl//karabo/extern/lib/python3.6/site-packages/calpy not the deployed tag: 1.9.0-2.4.1 not in [‘2.2.1-2.10.0-test3’]
CppFemSplitter: | affected devices: FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q1M1, FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q3M1 installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
InitLpdOnlineCorrection:
| affected devices: FXE_DET_LPD1M-1/CAL/INIT installed at: /scratch/xctrl//karabo/extern/lib/python3.6/site-packages/calML not the deployed tag: 1.6-2.4.1 not in [‘2.5.0-2.10.0’]
RestartCalServers:
| affected devices: FXE_DET_LPD1M-1/CAL/RESTART installed at: /scratch/xctrl//karabo/extern/lib/python3.6/site-packages/calML not the deployed tag: 1.6-2.4.1 not in [‘2.5.0-2.10.0’]
CppFemSplitter: | affected devices: FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q2M1, FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q4M1 installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CppFemSplitter: | affected devices: FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q2M2, FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q4M2 installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CppFemCombiner: | affected devices: FXE_XAD_JF1M/CAL/APPEND installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CalManager: | affected devices: FXE_XAD_JF1M/CAL/MANAGER, FXE_XAD_JF500K/CAL/MANAGER installed at: /scratch/xctrl//karabo/extern/lib/python3.6/site-packages/calPy.egg-link is a development install might be hot-fixed, dt=1 day, 0:00:00 not the deployed tag: jungfrau_multi_mem_cell not in [‘2.2.1-2.10.0-test3’]
CppFemSplitter: | affected devices: FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q2M3, FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q4M3 installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
CppFemSplitter: | affected devices: FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q2M4, FXE_DET_LPD1M-1/CAL/FEM_SPLITTER_Q4M4 installed at: /scratch/xctrl//karabo/plugins/libcppFemCombiner.so not the deployed tag: 1.3.0-2.4.1 not in [‘1.4.4-2.10.0’]
Ccmon: | affected devices: FXE_DET_LPD1M-1/CC/MON_0 installed at: /home/xctrl/karabo/plugins/libccmon.so not the deployed tag: 1.2.0-2.10.0 not in [‘1.2.8-2.11.1’]
Ccmon: | affected devices: FXE_DET_LPD1M-1/CC/MON_1 installed at: /home/xctrl/karabo/plugins/libccmon.so not the deployed tag: 1.2.0-2.10.0 not in [‘1.2.8-2.11.1’]
LpdComposite: | affected devices: FXE_DET_LPD1M-1/COMP/FEM_MDL_COMP installed at: /scratch/xctrl/karabo/extern/lib/python3.6/site-packages/lpdFem not the deployed tag: 2.3.3-2.10.0 not in [‘2.3.4-2.11.0’]
LPDMainControl: | affected devices: FXE_DET_LPD1M-1/COMP/MAIN_CNTRL installed at: None installation not in a standard path
LpdFem: | affected devices: FXE_DET_LPD1M-1/FPGA/FEM_Q1M1, FXE_DET_LPD1M-1/FPGA/FEM_Q1M2, FXE_DET_LPD1M-1/FPGA/FEM_Q1M3, FXE_DET_LPD1M-1/FPGA/FEM_Q1M4, FXE_DET_LPD1M-1/FPGA/FEM_Q2M1, FXE_DET_LPD1M-1/FPGA/FEM_Q2M2, FXE_DET_LPD1M-1/FPGA/FEM_Q2M3, FXE_DET_LPD1M-1/FPGA/FEM_Q2M4, FXE_DET_LPD1M-1/FPGA/FEM_Q3M1, FXE_DET_LPD1M-1/FPGA/FEM_Q3M2, FXE_DET_LPD1M-1/FPGA/FEM_Q3M3, FXE_DET_LPD1M-1/FPGA/FEM_Q3M4, FXE_DET_LPD1M-1/FPGA/FEM_Q4M1, FXE_DET_LPD1M-1/FPGA/FEM_Q4M2, FXE_DET_LPD1M-1/FPGA/FEM_Q4M3, FXE_DET_LPD1M-1/FPGA/FEM_Q4M4 installed at: /scratch/xctrl/karabo/extern/lib/python3.6/site-packages/lpdFem not the deployed tag: 2.3.3-2.10.0 not in [‘2.3.4-2.11.0’]
LPDDarkFrames: | affected devices: FXE_DET_LPD1M-1/PRCDR/DARKFRAMES installed at: None installation not in a standard path
TakeDataLPD: | affected devices: FXE_DET_LPD1M-1/PRCDR/TAKEDATA installed at: None installation not in a standard path

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/0CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/10CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/11CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/12CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/13CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/14CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/15CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/1CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/2CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/3CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/4CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/5CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/6CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/7CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/8CH0

Host could not be accessed

Affected classes:
| DataAggregator
Affected devices:
| FXE_DET_LPD1M-1/DET/9CH0
SlsCalibrator: | affected devices: FXE_ILH_TA/CAL/CONTROL installed at: None installation not in a standard path
GotthardControl:
| affected devices: FXE_ILH_TA/DET/CONTROL installed at: None installation not in a standard path
GotthardReceiver:
| affected devices: FXE_ILH_TA/DET/RECEIVER installed at: None installation not in a standard path
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/7 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/7_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeamImagingUnit:
| affected devices: FXE_OGT1_BIU/MDL/MAIN, FXE_OGT1_IPM/MDL/MAIN, FXE_OGT1_LAS/MDL/MAIN, FXE_OGT1_SA/MDL/CRYSTAL_SEL, FXE_OGT1_SA/MDL/ORDER_SEL installed at: None installation not in a standard path
BeckhoffAnalogInput:
| affected devices: FXE_OGT1_BIU/TSENS/ROD_TEMP1, FXE_OGT1_BIU/TSENS/ROD_TEMP2, FXE_OGT1_IPM/TSENS/TEMP1, FXE_OGT1_IPM/TSENS/TEMP2, FXE_OGT1_IPM/TSENS/TEMP3, FXE_OGT1_IPM/TSENS/TEMP4, FXE_OGT1_PSLIT/TSENS/BLADE1_TEMP1, FXE_OGT1_PSLIT/TSENS/BLADE1_TEMP2, FXE_OGT1_PSLIT/TSENS/BLADE2_TEMP1, FXE_OGT1_PSLIT/TSENS/BLADE2_TEMP2, FXE_OGT1_PSLIT/TSENS/BLADE3_TEMP1, FXE_OGT1_PSLIT/TSENS/BLADE3_TEMP2, FXE_OGT1_PSLIT/TSENS/BLADE4_TEMP1, FXE_OGT1_PSLIT/TSENS/BLADE4_TEMP2, FXE_OGT1_SA/TSENS/ROD_TEMP1, FXE_OGT1_SA/TSENS/ROD_TEMP2, FXE_OGT1_SA/TSENS/SA_TEMP, FXE_OGT1_VAC/GAUGE/ATT_CC, FXE_OGT1_VAC/GAUGE/PSLIT1_FR, FXE_OGT1_VAC/GAUGE/SA1_CC, FXE_OGT1_VAC/GAUGE/SA1_FR, FXE_OGT1_VAC/GAUGE/TAD_CC installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
SlitSystem: | affected devices: FXE_OGT1_PSLIT/MDL/MAIN installed at: None installation not in a standard path
BeckhoffMC2Base:
| affected devices: FXE_OGT1_PSLIT/MOTOR/BLADE1_IN_OUT installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
SlsCalibrator: | affected devices: FXE_OGT1_SA/CAL/DETECTOR installed at: None installation not in a standard path
GotthardReceiver:
| affected devices: FXE_OGT1_SA/DAQ/DETECTOR installed at: None installation not in a standard path
GotthardControl:
| affected devices: FXE_OGT1_SA/DET/DETECTOR installed at: None installation not in a standard path
ImageToSpectrum:
| affected devices: FXE_OGT1_SA/SPEC/GOTTHARD installed at: None installation not in a standard path
BeckhoffAgilentIonPump:
| affected devices: FXE_OGT1_VAC/2, FXE_OGT1_VAC/ICTRL/ATT_PUMP_CTL, FXE_OGT1_VAC/ICTRL/PSLIT1_SA1_PUMP_CTL, FXE_OGT1_VAC/IPUMP/ATT_IP55, FXE_OGT1_VAC/IPUMP/PSLIT1_IP150, FXE_OGT1_VAC/IPUMP/SA1_IP150 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalOutput:
| affected devices: FXE_OGT1_VAC/DCTRL/ATT_CC, FXE_OGT1_VAC/DCTRL/ATT_IP75_ON_SETPOINT, FXE_OGT1_VAC/DCTRL/GV1_OPEN, FXE_OGT1_VAC/DCTRL/GV2_OPEN, FXE_OGT1_VAC/DCTRL/INTERLOCK_ACTIV, FXE_OGT1_VAC/DCTRL/INTERLOCK_BRIDGED, FXE_OGT1_VAC/DCTRL/PSLIT1_FR_VALUE, FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_ON_SETPOINT, FXE_OGT1_VAC/DCTRL/SA1_CC, FXE_OGT1_VAC/DCTRL/SA1_IP150_ON_SETPOINT, FXE_OGT1_VAC/DCTRL/TAD_CC, FXE_SYS_VAC2MPS/DCTRL/FXE_VALVES_OPEN, FXE_TO_MPS/DCTRL/BEAM_MODE1, FXE_TO_MPS/DCTRL/BEAM_MODEF, FXE_TO_MPS/DCTRL/BEAM_MODEM, FXE_TO_MPS/DCTRL/BEAM_MODES, FXE_TO_MPS/DCTRL/SHUT_CLOSE_2B, FXE_TO_MPS/DCTRL/SHUT_CLOSE_4A installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalInput:
| affected devices: FXE_OGT1_VAC/SWITCH/GV1_OPEN, FXE_OGT1_VAC/SWITCH/GV2_OPEN, FXE_OGT1_VAC/SWITCH/INTERLOCK_KEY_NC, FXE_OGT1_VAC/SWITCH/INTERLOCK_KEY_NO, FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE_STATE_TRUE, FXE_OGT2_VAC/SWITCH/FV_OUTPUTOPEN_state, FXE_OGT2_VAC/SWITCH/GV_OPEN, FXE_TO_MPS/SWITCH/ABS_CLOSED, FXE_XTD9_VAC/SWITCH/SHUT_aclose, FXE_XTD9_VAC/SWITCH/SHUT_open, SA1_XTD9_VAC/SWITCH/P12290I_ON_SETPOINT, SA1_XTD9_VAC/SWITCH/VALVE_V12090M_OPEN_FXE, SA1_XTD9_VAC/SWITCH/VALVE_V12090M_open_FXE installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
ConditionValve: | affected devices: FXE_OGT1_VAC/VALVE/COND_GV1, FXE_OGT1_VAC/VALVE/COND_GV2 installed at: None installation not in a standard path
BeckhoffValve: | affected devices: FXE_OGT1_VAC/VALVE/GV1, FXE_OGT1_VAC/VALVE/GV2 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/1, FXE_RR_SYS/PLC/PRI installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/1_PLCMON, FXE_RR_SYS/PLC/PRI_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeamImagingUnit:
| affected devices: FXE_OGT3_BIU/MDL/MAIN, FXE_OGT3_IPM/MDL/MAIN installed at: None installation not in a standard path
BeckhoffAnalogInput:
| affected devices: FXE_OGT3_BIU/TSENS/ROD_TEMP1, FXE_OGT3_BIU/TSENS/ROD_TEMP2, FXE_OGT3_BIU/TSENS/ROD_TEMP3, FXE_OGT3_BIU/TSENS/ROD_TEMP4, FXE_OGT3_BIU/TSENS/SPARE1, FXE_OGT3_BIU/TSENS/SPARE2, FXE_OGT3_IPM/TSENS/TEMP1, FXE_OGT3_IPM/TSENS/TEMP2, FXE_OGT3_IPM/TSENS/TEMP3, FXE_OGT3_IPM/TSENS/TEMP4, FXE_OGT3_SA/TSENS/ROD_TEMP1, FXE_OGT3_SA/TSENS/ROD_TEMP2, FXE_OGT3_VAC/GAUGE/SA2_FR, FXE_OGT3_XGMD/ASENS/LV1_FSETPOINT, FXE_OGT3_XGMD/ASENS/LV1_PVALVE, FXE_OGT3_XGMD/ASENS/LV1_VPOSITION, FXE_OGT3_XGMD/ASENS/LV1_VSIGNAL, FXE_OGT3_XGMD/ASENS/XIN_ION1_FC, FXE_OGT3_XGMD/ASENS/XIN_ION2_FC, FXE_OGT3_XGMD/GAUGE/P2_1READ installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalOutput:
| affected devices: FXE_OGT3_PAM/DCTRL/SAMPLE_CAM, FXE_OGT3_XGMD/DCTRL/HV_LOCK, FXE_OGT3_XGMD/DCTRL/LV1_FDECREASE, FXE_OGT3_XGMD/DCTRL/LV1_FINCREASE, FXE_OGT3_XGMD/DCTRL/LV1_FMODE, FXE_OGT3_XGMD/DCTRL/LV1_PMODE, FXE_OGT3_XGMD/DCTRL/XIN_AMP_GAIN, FXE_OGT3_XGMD/DCTRL/XP_AMP_GAIN installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffMC2Base:
| affected devices: FXE_OGT3_PAM/MOTOR/SAMPLE1_Z, FXE_OGT3_PAM/PMOTOR/INCOUPLING_H_SPEC, FXE_OGT3_PAM/PMOTOR/INCOUPLING_V_SPEC, FXE_OGT3_PAM/PMOTOR/MIRROR_DOWN_1, FXE_OGT3_PAM/PMOTOR/MIRROR_DOWN_2, FXE_OGT3_PAM/PMOTOR/MIRROR_UP_1, FXE_OGT3_PAM/PMOTOR/MIRROR_UP_2, FXE_OGT3_PAM/PMOTOR/OUTCOUPLING_H_SPEC, FXE_OGT3_PAM/PMOTOR/OUTCOUPLING_V_SPEC installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
SlsCalibrator: | affected devices: FXE_OGT3_SA/CAL/CONTROL installed at: None installation not in a standard path
GotthardControl:
| affected devices: FXE_OGT3_SA/DET/CONTROL installed at: None installation not in a standard path
GotthardReceiver:
| affected devices: FXE_OGT3_SA/DET/RECEIVER installed at: None installation not in a standard path
BeckhoffPfeifferTCDriveUnit:
| affected devices: FXE_OGT3_VAC/TPUMP/SA2, FXE_OGT3_XGMD/TPUMP/XGMTP installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffAnalogOutput:
| affected devices: FXE_OGT3_XGMD/ACTRL/LV1_FSETPOINT, FXE_OGT3_XGMD/ACTRL/LV1_PRESSURE, FXE_OGT3_XGMD/ACTRL/LV1_PSETPOINT, FXE_OGT3_XGMD/ACTRL/SPARE installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalInput:
| affected devices: FXE_OGT3_XGMD/SWITCH/LV1_EMISSIONON, FXE_OGT3_XGMD/SWITCH/LV1_ERROR, FXE_OGT3_XGMD/SWITCH/LV1_LG, FXE_OGT3_XGMD/SWITCH/LV1_LO, FXE_OGT3_XGMD/SWITCH/LV1_POSITION, FXE_OGT3_XGMD/SWITCH/LV1_READY, FXE_OGT3_XGMD/SWITCH/LV1_SENERROR, FXE_OGT3_XGMD/SWITCH/LV1_SENSTATUS installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/8 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/8_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
GotthardControl:
| affected devices: FXE_OGT3_PAM/DET/CONTROL_SIG installed at: None installation not in a standard path
GotthardReceiver:
| affected devices: FXE_OGT3_PAM/DET/RECEIVER_SIG installed at: None installation not in a standard path
Mpod: | affected devices: FXE_RR_MPOD-1/MCPS/MPOD installed at: None installation not in a standard path
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/5 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/5_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffCom: | affected devices: FXE_RR_SYS/PLC/9 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: FXE_RR_SYS/PLC/9_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
JungfrauControl:
| affected devices: FXE_XAD_JF1M/DET/CONTROL, FXE_XAD_JF500K/DET/CONTROL installed at: None installation not in a standard path
JungfrauReceiver:
| affected devices: FXE_XAD_JF1M/DET/JNGFR01, FXE_XAD_JF1M/DET/JNGFR02, FXE_XAD_JF500K/DET/JNGFR03 installed at: None installation not in a standard path
JungfrauConfig: | affected devices: FXE_XAD_JF1M/MDL/CONFIG, FXE_XAD_JF500K/MDL/CONFIG installed at: None installation not in a standard path
JungfrauDarkChar:
| affected devices: FXE_XAD_JF1M/MDL/DARK, FXE_XAD_JF500K/MDL/DARK installed at: None installation not in a standard path
ImageProcessor: | affected devices: FXE_XTD9_IMGPI/PROC/BEAMVIEW installed at: None installation not in a standard path
CompoundRefractiveLens:
| affected devices: SA1_XTD2_CRL/MDL/CRL installed at: None installation not in a standard path

## Non-standard deployments

### fxe-rr-sys-con-2

- Rogue install for BeckhoffAnalogOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffAnalogInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for JJAttenuator: 2.5.3-2.11.0 installed but not in deployment.
- Rogue install for BeckhoffDigitalInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeamImagingUnit: 1.3.8-2.11.0 installed but not in deployment.
- Rogue install for BeckhoffAgilentIonPump: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for ConditionValve: 1.0.1-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffValve: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for SlsCalibrator: 1.4.1-2.10.0 installed but not in deployment.
- Rogue install for GotthardReceiver: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-4

- Rogue install for SlitSystem: 2.5.3-2.10.0 installed but not in deployment.
- Rogue install for BeamPositionMonitor: 1.7.1-2.10.0 installed but not in deployment.
- Rogue install for BeamImagingUnit: 1.3.8-2.11.0 installed but not in deployment.
- Rogue install for BeckhoffAnalogInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-6

- Rogue install for DoocsPhaseshifter: 1.8.14-2.11.1 installed but not in deployment.
- Rogue install for DoocsOpticalDelay: 1.8.14-2.11.1 installed but not in deployment.
- Rogue install for WavePlateControl: 1.0.2-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffDigitalOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffMC2Base: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for X2Timer: 1.8.14-2.11.1 installed but not in deployment.
- Rogue install for X2TimerML: 1.4.1-2.11.0 installed but not in deployment.
- Rogue install for DoocsPulseKicker: 1.8.14-2.11.1 installed but not in deployment.
- Rogue install for PulsePatternDecoder: 2.0.5-2.11.0 installed but not in deployment.
- Rogue install for DoocsXGM: 1.8.14-2.11.1 installed but not in deployment.

### la1-br-ppl-con-pattern

- Rogue install for PplMultiSubPattern: 1.5.6-2.10.0 installed but not in deployment.

### fxe-br-sys-con-12

- Rogue install for BeckhoffMonitor: 1.1.5-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for DoocsUndulatorEnergy: 1.8.14-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffEncoder: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeamImagingUnit: 1.3.8-2.11.0 installed but not in deployment.
- Rogue install for BeckhoffSimpleMotor: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffAnalogOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffAnalogInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for MonoChromator: 1.6.3-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffMC2Base: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for MonoChromatorGroup: 1.6.3-2.10.0 installed but not in deployment.

### fxe-rr-sys-con-3

- Rogue install for BeckhoffValve: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for CompoundRefractiveLens: 1.3.0-2.11.0 installed but not in deployment.
- Rogue install for BeckhoffAnalogInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for SlitSystem: 2.5.3-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-11

- Rogue install for DaqController: 1.4.6-2.11.1 installed but not in deployment.
- Rogue install for Karabacon: 2.4.5-2.11.1 installed but not in deployment.
- Rogue install for SimulatedTrigger: 1.1.1-2.10.4 installed but not in deployment.

### sa1-br-kc-comp-3

- Rogue install for TrainMatcher: 1.2.0-2.10.2 installed but not in deployment.
- Rogue install for PipeToZeroMQ: 3.2.5-2.11.0hotfix1 installed but not in deployment.

### sa1-br-sys-cal-2

- Rogue install for CppFemCombiner: 1.3.0-2.4.1 installed but not in deployment.
- Rogue install for CppFemSplitter: 1.3.0-2.4.1 installed but not in deployment.

### sa1-br-sys-cal-1

- Rogue install for CppFemCombiner: 1.3.0-2.4.1 installed but not in deployment.
- Rogue install for CppFemSplitter: 1.3.0-2.4.1 installed but not in deployment.

### sa1-br-sys-cal-3

- Rogue install for CppFemCombiner: 1.3.0-2.4.1 installed but not in deployment.
- Rogue install for CppFemSplitter: 1.3.0-2.4.1 installed but not in deployment.

### sa1-br-sys-cal-0

- Rogue install for CalManager: 1.9.0-2.4.1 installed but not in deployment.
- Rogue install for CppFemSplitter: 1.3.0-2.4.1 installed but not in deployment.
- Rogue install for InitLpdOnlineCorrection: 1.6-2.4.1 installed but not in deployment.
- Rogue install for RestartCalServers: 1.6-2.4.1 installed but not in deployment.

### sa1-br-sys-cal-4

- Rogue install for CppFemSplitter: 1.3.0-2.4.1 installed but not in deployment.

### sa1-br-sys-cal-5

- Rogue install for CppFemSplitter: 1.3.0-2.4.1 installed but not in deployment.
- Rogue install for CppFemCombiner: 1.3.0-2.4.1 installed but not in deployment.
- Rogue install for CalManager: jungfrau_multi_mem_cell installed but not in deployment.

### sa1-br-sys-cal-6

- Rogue install for CppFemSplitter: 1.3.0-2.4.1 installed but not in deployment.

### sa1-br-sys-cal-7

- Rogue install for CppFemSplitter: 1.3.0-2.4.1 installed but not in deployment.

### fxe-rr-sys-utc-1

- Rogue install for Ccmon: 1.2.0-2.10.0 installed but not in deployment.

### fxe-exp-sys-utc-1

- Rogue install for Ccmon: 1.2.0-2.10.0 installed but not in deployment.

### fxe-rr-sys-con-10

- Rogue install for ClockAndControlML: 2.0.0-2.10.0 installed but not in deployment.
- Rogue install for LpdComposite: 2.3.3-2.10.0 installed but not in deployment.
- Rogue install for LPDMainControl: 1.2.1-2.10.0 installed but not in deployment.
- Rogue install for LpdFem: 2.3.3-2.10.0 installed but not in deployment.
- Rogue install for LPDDarkFrames: 1.2.1-2.10.0 installed but not in deployment.
- Rogue install for TakeDataLPD: 1.2.1-2.10.0 installed but not in deployment.
- Rogue install for LpdPower: 1.1.2-2.10.0-hotfix installed but not in deployment.

### fxe-rr-sys-con-7

- Rogue install for SlsCalibrator: 1.4.1-2.10.0 installed but not in deployment.
- Rogue install for GotthardControl: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for GotthardReceiver: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-1

- Rogue install for BeamImagingUnit: 1.3.8-2.11.0 installed but not in deployment.
- Rogue install for BeckhoffAnalogInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for SlitSystem: 2.5.3-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffMC2Base: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for SlsCalibrator: 1.4.1-2.10.0 installed but not in deployment.
- Rogue install for GotthardReceiver: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for GotthardControl: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for ImageToSpectrum: 1.27.4-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffAgilentIonPump: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for ConditionValve: 1.0.1-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffValve: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-8

- Rogue install for BeamImagingUnit: 1.3.8-2.11.0 installed but not in deployment.
- Rogue install for BeckhoffAnalogInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffMC2Base: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for SlsCalibrator: 1.4.1-2.10.0 installed but not in deployment.
- Rogue install for GotthardControl: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for GotthardReceiver: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffPfeifferTCDriveUnit: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffAnalogOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-gotthard

- Rogue install for GotthardControl: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for GotthardReceiver: 1.8.4-2.10.0 installed but not in deployment.

### fxe-rr-sys-utc-2

- Rogue install for AdqDigitizer: 4.4.4-2.10.0 installed but not in deployment.
- Rogue install for TimeServer: 2.8.1-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-14

- Rogue install for Mpod: 5.2.3-2.10.4 installed but not in deployment.

### fxe-rr-sys-con-5

- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-9

- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-jungf

- Rogue install for JungfrauControl: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for JungfrauReceiver: 1.8.4-2.10.0 installed but not in deployment.
- Rogue install for JungfrauConfig: 1.2.3-2.11.1 installed but not in deployment.
- Rogue install for JungfrauDarkChar: 1.2.3-2.11.1 installed but not in deployment.

### fxe-rr-sys-con-13

- Rogue install for ImageProcessor: 1.27.4-2.10.0 installed but not in deployment.

## Non-standard instance ids

- FXE_OGT1_VAC/2
- FXE_OGT2_VAC/2
- FXE_OGT2_VAC/3
- KaraboGuiErrorLogger
- XFEL_FEL/DOOCS/MANAGER
- XFEL_FEL/UNDULATOR_ML/COLOR1_SA1
- XFEL_FEL/UNDULATOR_ML/COLOR1_SA2
- XFEL_FEL/XGM/XGM_3331_FXE

## Problematic Interface Configs

## Non-reachable devices

These devices are not included in any project or scene

- FXE_AUXT_AIO/ACTRL/OUT3
- FXE_AUXT_AIO/ACTRL/OUT4
- FXE_AUXT_AIO/ACTRL/OUT5
- FXE_AUXT_AIO/ACTRL/OUT6
- FXE_AUXT_AIO/ACTRL/OUT7
- FXE_AUXT_AIO/ACTRL/OUT8
- FXE_AUXT_AIO/ACTRL/OUT_HV_USET_
- FXE_AUXT_AIO/ACTRL/OUT_LLS3_SETPOINT
- FXE_AUXT_AIO/ASENS/IN4
- FXE_AUXT_AIO/ASENS/IN5
- FXE_AUXT_AIO/ASENS/IN6
- FXE_AUXT_AIO/ASENS/IN7
- FXE_AUXT_AIO/ASENS/IN8
- FXE_AUXT_AIO/ASENS/IN_HV_IREAD_
- FXE_AUXT_AIO/ASENS/IN_HV_UREAD_
- FXE_AUXT_AIO/ASENS/IN_LPM
- FXE_AUXT_AIO/ASENS/SPARE1
- FXE_AUXT_AIO/ASENS/SPARE2
- FXE_AUXT_AIO/ASENS/SPARE3
- FXE_AUXT_AIO/DCTRL/VSET_VMON_
- FXE_OGT1_VAC/SWITCH/ATT_IP75_ON_SETPOINT
- FXE_OGT1_VAC/SWITCH/PSLIT1_FR_VALUE
- FXE_OGT1_VAC/SWITCH/PSLIT1_IP150_ON_SETPOINT
- FXE_OGT2_VAC/2
- FXE_OGT2_VAC/3
- FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_STATE
- FXE_OGT2_VAC/DCTRL/FV_OUTPUTOPEN_STATE
- FXE_OGT2_VAC/DCTRL/GV_OPEN
- FXE_OGT2_VAC/DCTRL/INTERLOCK_ACTIV
- FXE_OGT2_VAC/DCTRL/INTERLOCK_BRIDGED
- FXE_OGT2_VAC/SWITCH/INTERLOCK_KEY_NC
- FXE_OGT2_VAC/SWITCH/INTERLOCK_KEY_NO
- FXE_RR_SYS/PLC/2_PLCMON
- FXE_AUXT_LIC/DOOCS/PPLASER
- FXE_AUXT_LIC/MDL/INTENSITY
- FXE_EXP_CHILLER/DCTRL/CHILLER_1_REMOTESTART
- FXE_EXP_CHILLER/SWITCH/CHILLER_1_COLLECTIVEALARM
- FXE_EXP_CHILLER/SWITCH/CHILLER_1_FLOWALARM
- FXE_EXP_CHILLER/SWITCH/CHILLER_1_GUIDEVALUEALARM
- FXE_EXP_CHILLER/SWITCH/CHILLER_1_PRESSUREALARM
- FXE_EXP_CHILLER/SWITCH/CHILLER_1_TEMPERATUREALARM
- FXE_EXP_CHILLER/SWITCH/CHILLER_1_WATERALARM
- FXE_ILH_CHILLER/DCTRL/CHILLER_1_REMOTESTART
- FXE_ILH_CHILLER/DCTRL/CHILLER_2_REMOTESTART
- FXE_ILH_CHILLER/SWITCH/CHILLER_1_COLLECTIVEALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_1_FLOWALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_1_GUIDEVALUEALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_1_PRESSUREALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_1_TEMPERATUREALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_1_WATERALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_2_COLLECTIVEALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_2_FLOWALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_2_GUIDEVALUEALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_2_PRESSUREALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_2_TEMPERATUREALARM
- FXE_ILH_CHILLER/SWITCH/CHILLER_2_WATERALARM
- FXE_RR_SYS/PLC/6_PLCMON
- FXE_RR_SYS/TSYS/UTC-1-S2
- FXE_RR_SYS/TSYS/UTC-2-S2
- FXE_RR_SYS/TSYS/UTC-2-S3
- FXE_RR_SYS/TVIEW/ILH_TRG3_GATE
- FXE_RR_SYS/TVIEW/TEST_TRIGGER
- SA1_CTRL_NBUNCH/DOOCS/XRAY_POD
- FXE_BR_SYS/PLC/12_PLCMON
- FXE_XTD9_DG/ENC/X_ROLL
- FXE_XTD9_DG/ENC/X_TRANS
- FXE_XTD9_DG/ENC/Y_TRANS
- FXE_XTD9_MONO-1/SWITCH/TOP_XTAL_ROLL_LFAULT
- FXE_XTD9_MONO-1/SWITCH/TOP_XTAL_RPITCH_LFAULT
- FXE_XTD9_MONO-2/ACTRL/TOP_XTAL_FPITCH
- FXE_XTD9_MONO-2/SWITCH/TOP_XTAL_ROLL_LFAULT
- FXE_XTD9_MONO-2/SWITCH/TOP_XTAL_RPITCH_LFAULT
- SA1_XTD9_SYS/SWITCH/C11804M_T1OK
- SA1_XTD9_SYS/SWITCH/C11804M_T2OK
- SA1_XTD9_SYS/SWITCH/C11804M_T3BALOK
- SA1_XTD9_SYS/SWITCH/C11804M_T3REDOK
- SA1_XTD9_SYS/SWITCH/C11805M_T1OK
- SA1_XTD9_SYS/SWITCH/C11805M_T2OK
- SA1_XTD9_SYS/SWITCH/C11805M_T3BALOK
- SA1_XTD9_SYS/SWITCH/C11805M_T3REDOK
- SA1_XTD9_SYS/SWITCH/C11806M_T1OK
- SA1_XTD9_SYS/SWITCH/C11806M_T2OK
- SA1_XTD9_SYS/SWITCH/C11806M_T3BALOK
- SA1_XTD9_SYS/SWITCH/C11806M_T3REDOK
- SA1_XTD9_SYS/SWITCH/C11808M_T1OK
- SA1_XTD9_SYS/SWITCH/C11808M_T2OK
- SA1_XTD9_SYS/SWITCH/C11808M_T3BALOK
- SA1_XTD9_SYS/SWITCH/C11808M_T3REDOK
- FXE_CRL_VAC/VALVE/GV2
- FXE_CRL_VAC/VALVE/GV3
- FXE_OGT2_CRL/MDL/MAIN
- FXE_RR_SYS/PLC/3_PLCMON
- FXE_DAQ_DATA/DM/DATA_MANAGER
- FXE_DAQ_DATA/DM/FEM_MDL_LPD_GROUP
- FXE_DAQ_DATA/DM/FXE_AUXT_AIO_GROUP
- FXE_DAQ_DATA/DM/FXE_AUXT_CSLIT_GROUP
- FXE_DAQ_DATA/DM/FXE_AUXT_LIC_GROUP
- FXE_DAQ_DATA/DM/FXE_DET_MOV_GROUP
- FXE_DAQ_DATA/DM/FXE_DOC_ADHOC_GROUP
- FXE_DAQ_DATA/DM/FXE_DOOCS_BAMS_GROUP
- FXE_DAQ_DATA/DM/FXE_ENERGY_GROUP
- FXE_DAQ_DATA/DM/FXE_ILH_TA_GOTTHARD_GROUP
- FXE_DAQ_DATA/DM/FXE_MONO_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT1_ATT_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT1_BIU_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT1_IPM_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT1_MOV_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT1_PSLIT_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT1_SA_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT1_TAD_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT1_VAC_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT2_BIU-1_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT2_BIU-2_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT2_CRL_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT2_CRL_LENS_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT2_MOV_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT2_PSLIT_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT2_VAC_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT3_BIU_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT3_IPM_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT3_MOV_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT3_SA_GROUP
- FXE_DAQ_DATA/DM/FXE_OGT3_XGMD_GROUP
- FXE_DAQ_DATA/DM/FXE_PPL_LAS_GROUP
- FXE_DAQ_DATA/DM/FXE_PPL_TRG_GROUP
- FXE_DAQ_DATA/DM/FXE_RR_SYS_DIGI_GROUP
- FXE_DAQ_DATA/DM/FXE_SA1_OPTICS_GROUP
- FXE_DAQ_DATA/DM/FXE_SCAN_GROUP
- FXE_DAQ_DATA/DM/FXE_SMS_CAM_GROUP
- FXE_DAQ_DATA/DM/FXE_SMS_JSS_GROUP
- FXE_DAQ_DATA/DM/FXE_SMS_MIC_GROUP
- FXE_DAQ_DATA/DM/FXE_SMS_MOV_GROUP
- FXE_DAQ_DATA/DM/FXE_SMS_USR_ALL_GROUP
- FXE_DAQ_DATA/DM/FXE_SMS_XEY_GROUP
- FXE_DAQ_DATA/DM/FXE_SYS_VAC2MPS_GROUP
- FXE_DAQ_DATA/DM/FXE_XAD_JF1M_1_GROUP
- FXE_DAQ_DATA/DM/FXE_XAD_JF1M_2_GROUP
- FXE_DAQ_DATA/DM/FXE_XAD_JF1M_CTRL_GROUP
- FXE_DAQ_DATA/DM/FXE_XAD_JF500K_CTRL_GROUP
- FXE_DAQ_DATA/DM/FXE_XAD_JF500K_GROUP
- FXE_DAQ_DATA/DM/LPD1M-1_XTDF_GROUP
- FXE_DAQ_DATA/DM/OGT3_GOTTHARD_GROUP
- FXE_DAQ_DATA/DM/TEST_DOOCS_GROUP
- FXE_DAQ_DATA/DOC/1
- FXE_DAQ_DATA/LPD1MCTRL/0
- FXE_DAQ_DATA/LPD1MCTRL/1
- FXE_DAQ_SCAN/MDL/DAQ_CONTROLLER
- FXE_DA_USR/MATCHER/MATCHER
- FXE_DA_USR/ZMQ/BRIDGE
- FXE_DET_LPD1M-1/TRAINMATCHER/LPD_NORM
- FXE_DET_LPD1M-1/ZMQ/APPEND_CORR
- FXE_XAD_JF1M/ZMQ/APPEND
- FXE_XAD_JF500K/ZMQ/CORR_GAIN
- FXE_OGT1_VAC/2
- FXE_OGT1_VAC/DCTRL/ATT_IP75_ON_SETPOINT
- FXE_OGT1_VAC/DCTRL/GV1_OPEN
- FXE_OGT1_VAC/DCTRL/GV2_OPEN
- FXE_OGT1_VAC/DCTRL/INTERLOCK_ACTIV
- FXE_OGT1_VAC/DCTRL/INTERLOCK_BRIDGED
- FXE_OGT1_VAC/DCTRL/PSLIT1_FR_VALUE
- FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_ON_SETPOINT
- FXE_OGT1_VAC/DCTRL/SA1_IP150_ON_SETPOINT
- FXE_OGT1_VAC/SWITCH/INTERLOCK_KEY_NC
- FXE_OGT1_VAC/SWITCH/INTERLOCK_KEY_NO
- FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE_STATE_TRUE
- FXE_RR_SYS/PLC/PRI_PLCMON
- FXE_TO_MPS/DCTRL/SHUT_CLOSE_2B
- FXE_TO_MPS/DCTRL/SHUT_CLOSE_4A
- FXE_OGT3_BIU/TSENS/ROD_TEMP3
- FXE_OGT3_BIU/TSENS/ROD_TEMP4
- FXE_OGT3_BIU/TSENS/SPARE1
- FXE_OGT3_BIU/TSENS/SPARE2
- FXE_OGT3_PAM/DCTRL/SAMPLE_CAM
- FXE_OGT3_PAM/MOTOR/SAMPLE1_Z
- FXE_OGT3_PAM/PMOTOR/INCOUPLING_H_SPEC
- FXE_OGT3_PAM/PMOTOR/INCOUPLING_V_SPEC
- FXE_OGT3_PAM/PMOTOR/MIRROR_DOWN_1
- FXE_OGT3_PAM/PMOTOR/MIRROR_DOWN_2
- FXE_OGT3_PAM/PMOTOR/MIRROR_UP_1
- FXE_OGT3_PAM/PMOTOR/MIRROR_UP_2
- FXE_OGT3_PAM/PMOTOR/OUTCOUPLING_H_SPEC
- FXE_OGT3_PAM/PMOTOR/OUTCOUPLING_V_SPEC
- FXE_OGT3_VAC/GAUGE/SA2_FR
- FXE_OGT3_VAC/TPUMP/SA2
- FXE_OGT3_XGMD/ACTRL/LV1_FSETPOINT
- FXE_OGT3_XGMD/ACTRL/LV1_PRESSURE
- FXE_OGT3_XGMD/ACTRL/LV1_PSETPOINT
- FXE_OGT3_XGMD/ACTRL/SPARE
- FXE_OGT3_XGMD/ASENS/LV1_FSETPOINT
- FXE_OGT3_XGMD/ASENS/LV1_PVALVE
- FXE_OGT3_XGMD/ASENS/LV1_VPOSITION
- FXE_OGT3_XGMD/ASENS/LV1_VSIGNAL
- FXE_OGT3_XGMD/ASENS/XIN_ION1_FC
- FXE_OGT3_XGMD/ASENS/XIN_ION2_FC
- FXE_OGT3_XGMD/DCTRL/HV_LOCK
- FXE_OGT3_XGMD/DCTRL/LV1_FDECREASE
- FXE_OGT3_XGMD/DCTRL/LV1_FINCREASE
- FXE_OGT3_XGMD/DCTRL/LV1_FMODE
- FXE_OGT3_XGMD/DCTRL/LV1_PMODE
- FXE_OGT3_XGMD/DCTRL/XIN_AMP_GAIN
- FXE_OGT3_XGMD/DCTRL/XP_AMP_GAIN
- FXE_OGT3_XGMD/GAUGE/P2_1READ
- FXE_OGT3_XGMD/SWITCH/LV1_EMISSIONON
- FXE_OGT3_XGMD/SWITCH/LV1_ERROR
- FXE_OGT3_XGMD/SWITCH/LV1_LG
- FXE_OGT3_XGMD/SWITCH/LV1_LO
- FXE_OGT3_XGMD/SWITCH/LV1_POSITION
- FXE_OGT3_XGMD/SWITCH/LV1_READY
- FXE_OGT3_XGMD/SWITCH/LV1_SENERROR
- FXE_OGT3_XGMD/SWITCH/LV1_SENSTATUS
- FXE_OGT3_XGMD/TPUMP/XGMTP
- FXE_RR_SYS/PLC/8_PLCMON
- FXE_RR_SYS/PLC/4_PLCMON
- FXE_RR_SYS/PLC/5_PLCMON
- FXE_RR_SYS/PLC/7_PLCMON
- FXE_RR_SYS/PLC/9_PLCMON
- FXE_XTD9_IMGPI/PROC/BEAMVIEW
- SA1_XTD2_CRL/MDL/CRL

## Access Rights Summary

CAL: | fxe-br-sys-con-12, sa1-br-sys-cal-2, sa1-br-sys-cal-4, fxe-rr-sys-con-9, fxe-rr-sys-con-2, fxe-rr-sys-con-10, sa1-br-sys-cal-0, sa1-br-sys-cal-7, fxe-rr-sys-con-8, fxe-rr-sys-con-13, sa1-br-sys-cal-1, fxe-rr-sys-con-7, fxe-rr-sys-con-14, fxe-rr-sys-con-gotthard, fxe-rr-sys-con-4, fxe-rr-sys-con-5, fxe-rr-sys-con-1, fxe-rr-sys-con-6, fxe-rr-sys-con-3, sa1-br-kc-comp-3, la1-br-ppl-con-pattern, fxe-rr-sys-con-jungf, sa1-br-sys-cal-3, sa1-br-sys-cal-6, fxe-rr-sys-con-11, sa1-br-sys-cal-5
CONTROLS: | fxe-br-sys-con-12, sa1-br-sys-cal-2, sa1-br-sys-cal-4, fxe-rr-sys-con-9, fxe-rr-sys-con-2, fxe-rr-sys-con-10, sa1-br-sys-cal-0, sa1-br-sys-cal-7, fxe-rr-sys-con-8, fxe-exp-sys-utc-1, fxe-rr-sys-con-13, sa1-br-sys-cal-1, fxe-rr-sys-con-7, fxe-rr-sys-con-14, fxe-rr-sys-con-gotthard, fxe-rr-sys-con-4, fxe-rr-sys-con-5, fxe-rr-sys-utc-2, fxe-rr-sys-con-1, fxe-rr-sys-con-6, fxe-rr-sys-con-3, sa1-br-kc-comp-3, la1-br-ppl-con-pattern, fxe-rr-sys-utc-1, fxe-rr-sys-con-jungf, sa1-br-sys-cal-3, sa1-br-sys-cal-6, fxe-rr-sys-con-11, sa1-br-sys-cal-5
CTRL: | fxe-br-sys-con-12, sa1-br-sys-cal-2, sa1-br-sys-cal-4, fxe-rr-sys-con-9, fxe-rr-sys-con-2, fxe-rr-sys-con-10, sa1-br-sys-cal-0, sa1-br-sys-cal-7, fxe-rr-sys-con-8, fxe-exp-sys-utc-1, fxe-rr-sys-con-13, sa1-br-sys-cal-1, fxe-rr-sys-con-7, fxe-rr-sys-con-14, fxe-rr-sys-con-gotthard, fxe-rr-sys-con-4, fxe-rr-sys-con-5, fxe-rr-sys-utc-2, fxe-rr-sys-con-1, fxe-rr-sys-con-6, fxe-rr-sys-con-3, sa1-br-kc-comp-3, la1-br-ppl-con-pattern, fxe-rr-sys-utc-1, fxe-rr-sys-con-jungf, sa1-br-sys-cal-3, sa1-br-sys-cal-6, fxe-rr-sys-con-11, sa1-br-sys-cal-5
DA: | fxe-br-sys-con-12, sa1-br-sys-cal-2, sa1-br-sys-cal-4, fxe-rr-sys-con-9, fxe-rr-sys-con-2, fxe-rr-sys-con-10, sa1-br-sys-cal-0, sa1-br-sys-cal-7, fxe-rr-sys-con-8, fxe-rr-sys-con-13, sa1-br-sys-cal-1, fxe-rr-sys-con-7, fxe-rr-sys-con-14, fxe-rr-sys-con-gotthard, fxe-rr-sys-con-4, fxe-rr-sys-con-5, fxe-rr-sys-con-1, fxe-rr-sys-con-6, fxe-rr-sys-con-3, sa1-br-kc-comp-3, la1-br-ppl-con-pattern, fxe-rr-sys-con-jungf, sa1-br-sys-cal-3, sa1-br-sys-cal-6, fxe-rr-sys-con-11, sa1-br-sys-cal-5
danilevc: | fxe-br-sys-con-12, sa1-br-sys-cal-2, sa1-br-sys-cal-4, fxe-rr-sys-con-9, fxe-rr-sys-con-2, sa1-br-sys-cal-0, sa1-br-sys-cal-7, fxe-rr-sys-con-8, fxe-rr-sys-con-13, sa1-br-sys-cal-1, fxe-rr-sys-con-7, fxe-rr-sys-con-14, fxe-rr-sys-con-gotthard, fxe-rr-sys-con-4, fxe-rr-sys-con-5, fxe-rr-sys-con-1, fxe-rr-sys-con-6, fxe-rr-sys-con-3, sa1-br-kc-comp-3, la1-br-ppl-con-pattern, fxe-rr-sys-con-jungf, sa1-br-sys-cal-3, sa1-br-sys-cal-6, fxe-rr-sys-con-11, sa1-br-sys-cal-5
xdoc: | fxe-br-sys-con-12, sa1-br-sys-cal-2, sa1-br-sys-cal-4, fxe-rr-sys-con-9, fxe-rr-sys-con-2, fxe-rr-sys-con-10, sa1-br-sys-cal-0, sa1-br-sys-cal-7, fxe-rr-sys-con-8, fxe-exp-sys-utc-1, fxe-rr-sys-con-13, sa1-br-sys-cal-1, fxe-rr-sys-con-7, fxe-rr-sys-con-14, fxe-rr-sys-con-gotthard, fxe-rr-sys-con-4, fxe-rr-sys-con-5, fxe-rr-sys-utc-2, fxe-rr-sys-con-1, fxe-rr-sys-con-6, fxe-rr-sys-con-3, sa1-br-kc-comp-3, la1-br-ppl-con-pattern, fxe-rr-sys-utc-1, fxe-rr-sys-con-jungf, sa1-br-sys-cal-3, sa1-br-sys-cal-6, fxe-rr-sys-con-11, sa1-br-sys-cal-5
tjezynsk: | la1-br-ppl-con-pattern
amunnich: | sa1-br-sys-cal-0, sa1-br-kc-comp-3, sa1-br-sys-cal-7, sa1-br-sys-cal-3, sa1-br-sys-cal-6, sa1-br-sys-cal-2, sa1-br-sys-cal-4, sa1-br-sys-cal-1, sa1-br-sys-cal-5
jsztuk: | sa1-br-sys-cal-0, sa1-br-kc-comp-3, sa1-br-sys-cal-7, sa1-br-sys-cal-3, sa1-br-sys-cal-6, sa1-br-sys-cal-2, sa1-br-sys-cal-4, sa1-br-sys-cal-1, sa1-br-sys-cal-5
kirkwood: | sa1-br-sys-cal-0, sa1-br-kc-comp-3, sa1-br-sys-cal-7, sa1-br-sys-cal-3, sa1-br-sys-cal-6, sa1-br-sys-cal-2, sa1-br-sys-cal-4, sa1-br-sys-cal-1, sa1-br-sys-cal-5
babies: | fxe-rr-sys-utc-2, fxe-rr-sys-utc-1, fxe-exp-sys-utc-1
cascella: | fxe-rr-sys-utc-2, fxe-rr-sys-utc-1, fxe-exp-sys-utc-1
mramilli: | fxe-rr-sys-utc-2, fxe-rr-sys-utc-1, fxe-exp-sys-utc-1, fxe-rr-sys-con-jungf
samartse: | fxe-rr-sys-utc-2, fxe-rr-sys-utc-1, fxe-exp-sys-utc-1
DET: | fxe-rr-sys-con-10
yousefh: | fxe-rr-sys-con-10
ardanaf: | fxe-rr-sys-con-gotthard

## Scenes with outdated properties

The following scenes my contain properties not available anymore, or only available as part of a macro, which is not guaranteed to alway run.

### Scenes

#### FXE_VHS_REL

projects: | FXE_SMS_VHS

- FXE_SMS_VHS/MOTOR/CR07_M3.stepLength
- FXE_SMS_VHS/MOTOR/CR06_M6.stepLength
- FXE_SMS_VHS/MOTOR/CR08_M6.stepLength
- FXE_SMS_VHS/MOTOR/CR13_M1.stepLength
- FXE_SMS_VHS/MOTOR/CR09_M2.stepLength
- FXE_SMS_VHS/MOTOR/CR03_M1.stepLength
- FXE_SMS_VHS/MOTOR/CR03_M3.stepLength
- FXE_SMS_VHS/MOTOR/CR05_M3.stepLength
- FXE_SMS_VHS/MOTOR/CR09_M3.stepLength
- FXE_SMS_VHS/MOTOR/CR09_M1.stepLength
- FXE_SMS_VHS/MOTOR/CR14_M5.stepLength
- FXE_SMS_VHS/MOTOR/CR15_M1.stepLength
- FXE_SMS_VHS/MOTOR/CR16_M4.stepLength
- FXE_SMS_VHS/MOTOR/CR16_M6.stepLength
- FXE_SMS_VHS/MOTOR/CR01_M3.stepLength
- FXE_SMS_VHS/MOTOR/CR14_M4.stepLength
- FXE_SMS_VHS/MOTOR/CR12_M6.stepLength
- FXE_SMS_VHS/MOTOR/CR06_M5.stepLength
- FXE_SMS_VHS/MOTOR/CR03_M2.stepLength
- FXE_SMS_VHS/MOTOR/CR04_M6.stepLength
- FXE_SMS_VHS/MOTOR/CR10_M6.stepLength
- FXE_SMS_VHS/MOTOR/CR15_M2.stepLength
- FXE_SMS_VHS/MOTOR/CR14_M6.stepLength
- FXE_SMS_VHS/MOTOR/CR04_M5.stepLength
- FXE_SMS_VHS/MOTOR/CR01_M1.stepLength
- FXE_SMS_VHS/MOTOR/CR08_M5.stepLength
- FXE_SMS_VHS/MOTOR/CR07_M1.stepLength
- FXE_SMS_VHS/MOTOR/CR07_M2.stepLength
- FXE_SMS_VHS/MOTOR/CR05_M1.stepLength
- FXE_SMS_VHS/MOTOR/CR08_M4.stepLength
- FXE_SMS_VHS/MOTOR/CR02_M5.stepLength
- FXE_SMS_VHS/MOTOR/CR13_M2.stepLength
- FXE_SMS_VHS/MOTOR/CR11_M1.stepLength
- FXE_SMS_VHS/MOTOR/CR15_M3.stepLength
- FXE_SMS_VHS/MOTOR/CR05_M2.stepLength
- FXE_SMS_VHS/MOTOR/CR01_M2.stepLength
- FXE_SMS_VHS/MOTOR/CR04_M4.stepLength
- FXE_SMS_VHS/MOTOR/CR10_M4.stepLength
- FXE_SMS_VHS/MOTOR/CR10_M5.stepLength
- FXE_SMS_VHS/MOTOR/CR16_M5.stepLength
- FXE_SMS_VHS/MOTOR/CR06_M4.stepLength
- FXE_SMS_VHS/MOTOR/CR13_M3.stepLength
- FXE_SMS_VHS/MOTOR/CR02_M6.stepLength
- FXE_SMS_VHS/MOTOR/CR11_M2.stepLength
- FXE_SMS_VHS/MOTOR/CR02_M4.stepLength
- FXE_SMS_VHS/MOTOR/CR12_M4.stepLength
- FXE_SMS_VHS/MOTOR/CR11_M3.stepLength
- FXE_SMS_VHS/MOTOR/CR12_M5.stepLength

#### FXE_OGT1_TAD/CAM/CAMERA|scene

projects: | FXE_OGT1_TAD

- FXE_OGT1_TAD/CAM/CAMERA.latencyTime

#### Configuration group

projects: | FXE_TEST_SLOW_DATA

- FXE_DAQ_DATA/DM/RUN_CONFIG_GROUP.group.expert

#### FXE-ADQ-GENERAL

projects: | FXE_ADQ7

- FXE_RR_DAQ/ADC/1.board2.zero.channel_3_enable
- FXE_RR_DAQ/ADC/1.board2.zero.channel_2_enable
- FXE_RR_DAQ/ADC/1.board4.threshold.hardware.limiter
- FXE_RR_DAQ/ADC/1.board2.threshold.hardware.limiter
- FXE_RR_DAQ/ADC/1.board3.zero.channel_3_enable
- FXE_RR_DAQ/ADC/1.board4.zero.channel_2_enable
- FXE_RR_DAQ/ADC/1.board1.threshold.software.channel_0
- FXE_RR_DAQ/ADC/1.board2.zero.channel_1_enable
- FXE_RR_DAQ/ADC/1.board2.threshold.software.channel_3
- FXE_RR_DAQ/ADC/1.board1.threshold.hardware.limiter
- FXE_RR_DAQ/ADC/1.board1.threshold.software.channel_2
- FXE_RR_DAQ/ADC/1.board4.threshold.software.channel_0
- FXE_RR_DAQ/ADC/1.board4.threshold.software.channel_2
- FXE_RR_DAQ/ADC/1.board2.threshold.software.channel_0
- FXE_RR_DAQ/ADC/1.board3.threshold.hardware.limiter
- FXE_RR_DAQ/ADC/1.board3.zero.channel_2_enable
- FXE_RR_DAQ/ADC/1.board2.threshold.software.channel_2
- FXE_RR_DAQ/ADC/1.board3.threshold.software.channel_0
- FXE_RR_DAQ/ADC/1.board2.threshold.hardware.threshold
- FXE_RR_DAQ/ADC/1.board3.threshold.software.channel_3
- FXE_RR_DAQ/ADC/1.board3.zero.channel_0_enable
- FXE_RR_DAQ/ADC/1.board3.threshold.software.channel_2
- FXE_RR_DAQ/ADC/1.board4.zero.channel_3_enable
- FXE_RR_DAQ/ADC/1.board3.threshold.software.channel_1
- FXE_RR_DAQ/ADC/1.board1.zero.channel_3_enable
- FXE_RR_DAQ/ADC/1.board4.threshold.software.channel_3
- FXE_RR_DAQ/ADC/1.board1.zero.channel_0_enable
- FXE_RR_DAQ/ADC/1.board1.threshold.software.channel_1
- FXE_RR_DAQ/ADC/1.board3.threshold.hardware.threshold
- FXE_RR_DAQ/ADC/1.board1.zero.channel_2_enable
- FXE_RR_DAQ/ADC/1.board4.zero.channel_0_enable
- FXE_RR_DAQ/ADC/1.board1.zero.count
- FXE_RR_DAQ/ADC/1.board1.zero.channel_1_enable
- FXE_RR_DAQ/ADC/1.board1.threshold.software.channel_3
- FXE_RR_DAQ/ADC/1.board2.zero.count
- FXE_RR_DAQ/ADC/1.board3.zero.channel_1_enable
- FXE_RR_DAQ/ADC/1.board4.threshold.hardware.threshold
- FXE_RR_DAQ/ADC/1.board2.zero.channel_0_enable
- FXE_RR_DAQ/ADC/1.board3.zero.count
- FXE_RR_DAQ/ADC/1.board4.threshold.software.channel_1
- FXE_RR_DAQ/ADC/1.board2.threshold.software.channel_1
- FXE_RR_DAQ/ADC/1.board1.threshold.hardware.threshold
- FXE_RR_DAQ/ADC/1.board4.zero.channel_1_enable
- FXE_RR_DAQ/ADC/1.board4.zero.count

#### Heaters

projects: | FXE_XTD9_MONO-2

- FXE_XTD9_MONO-2/ASENS/I2._deviceId_
- FXE_XTD9_MONO-1/ACTRL/U2.deviceId
- FXE_XTD9_MONO-2/ACTRL/U0.value
- FXE_XTD9_MONO-1/ACTRL/U2.value
- FXE_XTD9_MONO-1/ACTRL/U0.value
- FXE_XTD9_MONO-1/ACTRL/U1.deviceId
- FXE_XTD9_MONO-1/ACTRL/U0.deviceId
- FXE_XTD9_MONO-1/ASENS/I0.value
- FXE_XTD9_MONO-1/ASENS/I2.deviceId
- FXE_XTD9_MONO-2/ASENS/I0.value
- FXE_XTD9_MONO-1/ASENS/I0.deviceId
- FXE_XTD9_MONO-2/ASENS/I1._deviceId_
- FXE_XTD9_MONO-2/ACTRL/U2._deviceId_
- FXE_XTD9_MONO-2/ACTRL/U0._deviceId_
- FXE_XTD9_MONO-2/ACTRL/U1._deviceId_
- FXE_XTD9_MONO-2/ACTRL/U2.value
- FXE_XTD9_MONO-2/ACTRL/U1.value
- FXE_XTD9_MONO-1/ACTRL/U1.value
- FXE_XTD9_MONO-2/ASENS/I1.value
- FXE_XTD9_MONO-1/ASENS/I1.deviceId
- FXE_XTD9_MONO-1/ASENS/I1.value
- FXE_XTD9_MONO-1/ASENS/I2.value
- FXE_XTD9_MONO-2/ASENS/I0.deviceId
- FXE_XTD9_MONO-2/ASENS/I2.value

#### FXE_TO_MPS_DCTRL_BEAM_MODES_INTERLOCK

projects: | FXE_BECKHOFF

- FXE_TO_MPS/DCTRL/BEAM_MODES.targetPosition

#### FXE_OGT1_TAD_GOTTHARD

projects: | FXE_OGT1_TAD

- FXE_OGT1_TAD/DET/GOTTHARD_DETECTOR-1.exposurePeriod
- FXE_OGT1_TAD/DET/GOTTHARD_DETECTOR-1.settings
- FXE_OGT1_TAD/DET/GOTTHARD_DETECTOR-1.stop
- FXE_OGT1_TAD/DET/GOTTHARD_DETECTOR-1.numberOfCycles
- FXE_OGT1_TAD/DET/GOTTHARD_RECEIVER-1.frameRateIn
- FXE_OGT1_TAD/CAL/GOTTHARD_DETECTOR-1.display.schema.calibratedData
- FXE_OGT1_TAD/CAL/GOTTHARD_DETECTOR-1.frameNumber
- FXE_OGT1_TAD/CAL/GOTTHARD_DETECTOR-1.frameToDisplay
- FXE_OGT1_TAD/DET/GOTTHARD_DETECTOR-1.start
- FXE_OGT1_TAD/DET/GOTTHARD_DETECTOR-1.exposureTime
- FXE_OGT1_TAD/DET/GOTTHARD_DETECTOR-1.numberOfFrames
- FXE_OGT1_TAD/CAL/GOTTHARD_DETECTOR-1.useBackgroundFrame
- FXE_OGT1_TAD/CAL/GOTTHARD_DETECTOR-1.averagedDisplay

#### FemTemp Monitor

projects: | LPD_Control

- FXE_DET_LPD1M-1/FPGA/FEM_Q1M1.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q1M1.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q1M2.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q1M2.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q1M3.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q1M3.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M1.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M1.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M2.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M2.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M3.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M3.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q3M1.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q3M1.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q3M2.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q3M2.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q3M3.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q3M3.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q3M4.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q3M4.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q4M1.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q4M1.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q4M2.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q4M2.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q4M3.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q4M3.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q4M4.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q4M4.powerCardTemp1

#### test

projects: | FXE_CONF_MANAGER

- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.category
- FXE_XAD_JF1M/DET/RECEIVER-1.daqOutput.schema.data.frameNumber
- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q4M3.preview.previewOutput.schema.image
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.logbook
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.type
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.text
- FXE_XAD_JF1M/DET/RECEIVER-1.daqOutput.schema.data.timestamp
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.execute
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.subject
- FXE_XAD_JF1M/DET/RECEIVER-1.daqOutput.schema.data.memoryCell

#### CnC Quick Configuration

projects: | LPD_CLOCK_CONTROL

- mon-000.ccNormalOperation
- mon-000.fast_custom_message

#### CnC Trigger Simulation

projects: | LPD_CLOCK_CONTROL

- mon-000.fast_custom_message
- mon-000.trigger_delay
- mon-000.trigger_period
- mon-000.stop_trigger_limit

#### Prepare VETO Pattern

projects: | LPD_CLOCK_CONTROL

- mon-000.veto_pattern
- mon-000.veto_pulses
- mon-000.n_no_veto_number
- mon-000.mth_pulse_no_veto
- mon-000.no_veto_pulses
- mon-000.golden_pulses

#### CnC Spare Trigger

projects: | LPD_CLOCK_CONTROL

- mon-000.spare_trigger_repeat
- mon-000.spare_trigger_delay
- mon-000.spare_trigger_period
- mon-000.spare_trigger_mask
- FXE_DET_LPD1M-1/CC/MON_0.upload_mask_values
- mon-000.spare_trigger_width

#### offset_corrected_preview_Q3

projects: | LPD_CAL_Q3

- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q3M2.dataOutput.schema.header.trainId
- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q3M1.dataOutput.schema.header.pulseCount
- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q3M2.dataOutput.schema.header.pulseCount
- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q3M4.dataOutput.schema.header.trainId
- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q3M3.dataOutput.schema.header.trainId
- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q3M3.dataOutput.schema.header.pulseCount
- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q3M4.dataOutput.schema.header.pulseCount
- FXE_DET_LPD1M/CAL/CORR_OFFSET_Q3M1.dataOutput.schema.header.trainId

#### MAIN

projects: | TEST_GENERIC_VALIDATOR

- digitizer.board_1.schema.channel_A.length
- digitizer.board_1.schema.channel_A.triggerId
- digitizer.board_1.schema.channel_A.pulseNum
- digitizer.board_1.schema.channel_A.pulseIntegral

#### PSCU Overview

projects: | LPD_Control

- FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp0.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp1.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp2.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp3.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp4.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp5.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp8.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp9.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp0.value
- FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp0.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp1.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp2.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp3.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp4.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp5.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp8.value,FXE_DET_LPD1M-1/PSC/PSCU.temperature.temp9.value

#### FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV2

projects: | FXE_INTERLOCK

- FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE_state_true.state

#### FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value

projects: | FXE_INTERLOCK

- FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value.interlock.AConditionState
- FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value.interlock.AActionState

#### FXE_RR_SYS/ILOCK/MAIN|Global interlock

projects: | FXE_INTERLOCK

- FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value.interlock.AConditionState
- FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint.interlock.AConditionState
- FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state.interlock.AConditionState
- FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state.interlock.AActionState
- FXE_OGT1_VAC/SWITCH/PSLIT1_FR_value.state
- FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE_state_true.state
- FXE_OGT1_VAC/SWITCH/PSLIT1_IP150_on_setpoint.state
- FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint.interlock.AActionState
- FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint.interlock.AConditionState
- SA1_XTD9_VAC/SWITCH/P12290I_on_setpoint.state
- FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value.interlock.AActionState
- FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint.interlock.AActionState
- FXE_OGT1_VAC/SWITCH/ATT_IP75_on_setpoint.state

#### VAC-SIGNALS

projects: | FXE-VAC-SIGNAL-EXCHANGE

- SA1_XTD9_VAC/SWITCH/P12290I_on_setpoint._deviceId_
- SA1_XTD9_VAC/SWITCH/P12290I_on_setpoint.state

#### FXE-ADQ-RAW

projects: | FXE_ADQ7

- FXE_RR_DAQ/ADC/1.board1.zero.count

#### LPD_DAQ_V2

projects: | LPD_DAQ_SCENE_V2

- FXE_DAQ_LPD1M-1/DM/RUN_CONTROL.dataType
- FXE_DAQ_LPD1M-1/DM/RUN_CONTROL.runNumber
- FXE_DAQ_LPD1M-1/DM/RUN_CONTROL.sample
- FXE_DAQ_LPD1M-1/DM/RUN_CONTROL.experiment
- FXE_DAQ_LPD1M-1/DM/RUN_CONTROL.state

#### FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/VALVE/GV

projects: | FXE_INTERLOCK

- FXE_OGT1_VAC/SWITCH/PSLIT1_IP150_on_setpoint.state
- FXE_OGT1_VAC/SWITCH/PSLIT1_FR_value.state
- FXE_OGT1_VAC/SWITCH/ATT_IP75_on_setpoint.state

#### Run controller

projects: | FXE_TEST_SLOW_DATA_copy

- FXE_DAQ_DATA/DM/RUN_CONTROLLER.sample
- FXE_DAQ_DATA/DM/RUN_CONTROLLER.dataSourceToAggregatorsMapping
- FXE_DAQ_DATA/DM/RUN_CONTROLLER.experiment

#### Run configurator

projects: | FXE_TEST_SLOW_DATA_copy

- FXE_DAQ_DATA/DM/RUN_CONFIGURATOR.buildConfigurationInUse
- FXE_DAQ_DATA/DM/RUN_CONFIGURATOR.availableGroups

#### TEST-SCENE-MONO-2

projects: | FXE_XTD9_MONO-2

- FXE_XTD9_MONO-2/MDL/ACCM_PITCH.deltaTheta
- FXE_XTD9_MONO-2/MDL/ACCM_PITCH.calibratedBragg
- FXE_XTD9_MONO-2/MDL/ACCM_PITCH.deltaX
- FXE_XTD9_MONO-2/MDL/ACCM_PITCH.offset
- FXE_XTD9_MONO-2/MDL/ACCM_PITCH.actualBraggAngle

#### MONO1_TEMP

projects: | FXE-VAC-SIGNAL-EXCHANGE

- FXE_XTD9_MONO-1/TSENS/T0.value,FXE_XTD9_MONO-1/TSENS/T1.value,FXE_XTD9_MONO-1/TSENS/T2.value

#### MONO2_TEMP

projects: | FXE-VAC-SIGNAL-EXCHANGE

- FXE_XTD9_MONO-2/TSENS/T0.value,FXE_XTD9_MONO-2/TSENS/T1.value,FXE_XTD9_MONO-2/TSENS/T2.value

#### BunchPattern

projects: | TEST_BUNCH_DIGITIZER

- digiBunchPattern.stop
- digiBunchPattern.Board_1.Channel_D.peakIntegrationRange
- digiBunchPattern.Board_2.Channel_A.enable
- digiBunchPattern.Board_2.Channel_A.baselineIntegrationRange
- digiBunchPattern.start
- digiBunchPattern.Board_2.Channel_A.peakOnSet
- digiBunchPattern.Board_1.Channel_C.enable
- digiBunchPattern.Board_1.Channel_C.peakIntegrationRange
- digiBunchPattern.Board_1.Channel_D.enable
- digiBunchPattern.Board_1.Channel_C.peakOnSet
- digiBunchPattern.Board_1.Channel_B.baselineIntegrationRange
- digiBunchPattern.Board_1.Channel_B.peakOnSet
- digiBunchPattern.Board_2.Channel_A.peakIntegrationRange
- digiBunchPattern.apply
- digiBunchPattern.Board_1.Channel_C.baselineIntegrationRange
- digiBunchPattern.Board_1.Channel_D.baselineIntegrationRange
- digiBunchPattern.Board_1.enable
- digiBunchPattern.Board_1.Channel_B.peakIntegrationRange
- digiBunchPattern.Board_1.Channel_B.enable
- digiBunchPattern.Board_1.Channel_D.peakOnSet

#### bunchPatternDigitizer

projects: | TEST_BUNCH_DIGITIZER

- digiBunchPattern.Board_1.Channel_B.baselineIntegrationRange
- digiBunchPattern.Board_1.Channel_B.peakOnSet
- digiBunchPattern.Board_1.enable
- digiBunchPattern.Board_1.Channel_B.peakIntegrationRange
- digiBunchPattern.Board_1.Channel_B.enable

#### raw_preview_Q3

projects: | LPD_CAL_Q3

- FXE_DET_LPD1M/CAL/CALC_OFFSET_Q3M1.dataOutput.schema.header.trainId
- FXE_DET_LPD1M/CAL/CALC_OFFSET_Q3M2.dataOutput.schema.header.pulseCount
- FXE_DET_LPD1M/CAL/CALC_OFFSET_Q3M3.dataOutput.schema.header.trainId
- FXE_DET_LPD1M/CAL/CALC_OFFSET_Q3M2.dataOutput.schema.header.trainId
- FXE_DET_LPD1M/CAL/CALC_OFFSET_Q3M4.dataOutput.schema.header.pulseCount
- FXE_DET_LPD1M/CAL/CALC_OFFSET_Q3M3.dataOutput.schema.header.pulseCount
- FXE_DET_LPD1M/CAL/CALC_OFFSET_Q3M4.dataOutput.schema.header.trainId
- FXE_DET_LPD1M/CAL/CALC_OFFSET_Q3M1.dataOutput.schema.header.pulseCount

#### FXE_OGT3_SA/CAM/CAMERA|scene

projects: | FXE_OGT3_SA

- FXE_OGT3_SA/CAM/CAMERA.latencyTime

#### SPECTRUM_NORM

projects: | GREATEYES

- FXE_XAD_GEC/MDL/ROI_SPECTRUM.output.schema.data.spectrum
- FXE_XAD_GEC/MDL/ROI_SPECTRUM.spectrumIntegral

#### RAW_OVERVIEW

projects: | LPD_ONLINE_CAL

- FXE_DET_LPD1M-1/CAL/COMBINE_RAW_GAIN.sendIfNonComplete

#### He-decon-IPUMPS

projects: | FXE-VAC-SIGNAL-EXCHANGE

- FXE_OGT2_VAC/IPUMP/DW_IP75.pressure,FXE_OGT2_VAC/IPUMP/PSLIT2_IP150.pressure,FXE_OGT2_VAC/IPUMP/CRL_IP55.pressure,FXE_OGT1_VAC/IPUMP/ATT_IP55.pressure,FXE_OGT1_VAC/IPUMP/PSLIT1_IP150.pressure,FXE_OGT1_VAC/IPUMP/SA1_IP150.pressure

#### He-decon-GAUGES

projects: | FXE-VAC-SIGNAL-EXCHANGE

- FXE_OGT2_VAC/GAUGE/DW_FR.value,FXE_OGT2_VAC/GAUGE/PSLIT2_FR.value,FXE_OGT2_VAC/GAUGE/CRL_CC.value,FXE_OGT1_VAC/GAUGE/PSLIT1_FR.value,FXE_OGT1_VAC/GAUGE/SA1_FR.value,FXE_OGT1_VAC/GAUGE/SA1_CC.value

#### FXE_TO_MPS_DCTRL_BEAM_MODEF_INTERLOCK

projects: | FXE_INTERLOCK

- FXE_TO_MPS/DCTRL/BEAM_MODEF.targetPosition

#### FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH|motorScene

projects: | FXE_XTD9_MONO-1

- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.swLimitHigh
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.moveRelative
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.mc2.aaxismaxvelocity
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.mc2.aaxisdec
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.mc2.aaxisacc
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.enableSWLimitHigh
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.enableSWLimitLow
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.mc2.amovedirection
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.mc2.aaxisjerk
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.swLimitLow
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.stepSize
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.calibrateToEncoder
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.resetAxis
- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.specificError

#### FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH|motorScene

projects: | FXE_XTD9_MONO-2

- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.swLimitLow
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.calibrateToEncoder
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.mc2.aaxismaxvelocity
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.mc2.amovedirection
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.swLimitHigh
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.mc2.aaxisacc
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.enableSWLimitHigh
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.mc2.aaxisjerk
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.resetAxis
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.enableSWLimitLow
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.moveRelative
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.specificError
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.stepSize
- FXE_XTD9_MONO-2/MOTOR/ACCM_PITCH.mc2.aaxisdec

#### CI_SCAN

projects: | LPD_CAL_CHARGE_INJECTION

- FXE_DET_LPD1M/MDL/GAIN_CAL.do50pf
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_3.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_3.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_3.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_0.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_2.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_1.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_2.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_1.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_0.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_3.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_2.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_3.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_2.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_1.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_1.file_count
- FXE_DET_LPD1M/MDL/GAIN_CAL.delay
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_1.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_3.file_count
- FXE_DET_LPD1M/MDL/GAIN_CAL.do5pf
- FXE_DET_LPD1M/MDL/GAIN_CAL.resume
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_0.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_1.file_count
- FXE_DET_LPD1M/MDL/GAIN_CAL.status
- FXE_DET_LPD1M/MDL/GAIN_CAL.state
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_1.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_3.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_3.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_0.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_0.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_0.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_1.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_1.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_2.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_2.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_3.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_3.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_0.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_0.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_1.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_1.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_2.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_2.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_3.current_image,FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_3.current_image
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_0.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q4_2.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_2.image_counter
- FXE_DET_LPD1M/CAL/MANAGER_CI.state
- FXE_DET_LPD1M/MDL/GAIN_CAL.restartFrom
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_0.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_1.file_count
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q2_0.image_counter
- FXE_DET_LPD1M/CAL/MANAGER_CI.nCells
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_0.image_counter
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q1_2.file_count
- FXE_DET_LPD1M/MDL/GAIN_CAL.gainScan
- FXE_DET_LPD1M/CAL/MANAGER_CI.initCalibration
- FXE_DET_LPD1M/MDL/GAIN_CAL.requestPause
- FXE_DET_LPD1M/CAL/CHUNKWRITER_Q3_2.file_count
- FXE_DET_LPD1M/MDL/GAIN_CAL.cancel

#### Digitizer_Data

projects: | TEST_BUNCH_DIGITIZER

- apdData.board_1.schema.channel_A.pulseId
- beamPositionMonitor.daqOutput.schema.data.y
- beamPositionMonitor.trainValidity
- beamPositionMonitor.quadrant
- apdData.board_1.schema.channel_A.triggerId
- beamPositionMonitor.output.schema.data.x
- beamPositionMonitor1.output.schema.data.avgTop
- apdData.board_1.schema.channel_A.pulseIntegral
- apdData.state
- apdData.board_1.schema.channel_A.length
- beamPositionMonitor.pulseValidity

#### CORRELATOR_OVERVIEW

projects: | ZMQ_BRIDGE

- FXE_RR_SYS/CORRELATION/JF_MOTOR.processing.latestTid
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.reset
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.channel
- FXE_RR_SYS/CORRELATION/JF_MOTOR.slowTable
- FXE_MOTOR_LPD1M-1/CORRELATOR.state
- FXE_MOTOR_JF500K/CORRELATOR.processing.latestTid
- FXE_MOTOR_LPD1M-1/CORRELATOR.detectorId
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR._deviceId_
- FXE_RR_SYS/ZMQ/LPD1M1_MOTOR.activate
- FXE_MOTOR_JF500K/CORRELATOR.stop
- FXE_MOTOR_JF500K/CORRELATOR._deviceId_
- FXE_RR_SYS/CORRELATION/JF_MOTOR.detectorId
- FXE_MOTOR_JF500K/COR/ZMQ.input.connectedOutputChannels
- FXE_RR_SYS/ZMQ/LPD1M1_MOTOR.data_sent0
- FXE_RR_SYS/ZMQ/LPD1M1_MOTOR.input.connectedOutputChannels
- FXE_RR_SYS/CORRELATION/JF_MOTOR.reset
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.processing.latestBufferSize
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.processing.latestSources
- FXE_MOTOR_JF500K/CORRELATOR.state
- FXE_MOTOR_JF500K/CORRELATOR.processing.latestSources
- FXE_MOTOR_JF500K/CORRELATOR.status
- FXE_MOTOR_JF500K/COR/ZMQ.data_sent0
- FXE_MOTOR_JF500K/CORRELATOR.channel
- FXE_MOTOR_LPD1M-1/CORRELATOR.stop
- FXE_MOTOR_JF500K/COR/ZMQ.deactivate
- FXE_MOTOR_LPD1M-1/COR/ZMQ.adressOutput0
- FXE_RR_SYS/CORRELATION/JF_MOTOR.start
- FXE_RR_SYS/CORRELATION/JF_MOTOR._deviceId_
- FXE_RR_SYS/ZMQ/JF_MOTOR.activate
- FXE_RR_SYS/CORRELATION/JF_MOTOR.processing.latestSources
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.start
- FXE_RR_SYS/CORRELATION/JF_MOTOR.status
- FXE_MOTOR_JF500K/CORRELATOR.processing.latestBufferSize
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.slowTable
- FXE_MOTOR_JF500K/CORRELATOR.slowTable
- FXE_MOTOR_LPD1M-1/CORRELATOR.detectorProperty
- FXE_MOTOR_JF500K/CORRELATOR.reset
- FXE_MOTOR_JF500K/CORRELATOR.start
- FXE_MOTOR_JF500K/CORRELATOR.motorTable
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.processing.latestTid
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.stop
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.state
- FXE_MOTOR_LPD1M-1/COR/ZMQ.input.connectedOutputChannels
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.status
- FXE_RR_SYS/ZMQ/JF_MOTOR.input.connectedOutputChannels
- FXE_RR_SYS/ZMQ/JF_MOTOR.adressOutput0
- FXE_MOTOR_LPD1M-1/CORRELATOR.reset
- FXE_RR_SYS/ZMQ/LPD1M1_MOTOR.adressOutput0
- FXE_RR_SYS/CORRELATION/JF_MOTOR.motorTable
- FXE_MOTOR_JF500K/COR/ZMQ.adressOutput0
- FXE_RR_SYS/CORRELATION/JF_MOTOR.processing.latestBufferSize
- FXE_RR_SYS/CORRELATION/JF_MOTOR.detectorProperty
- FXE_RR_SYS/CORRELATION/JF_MOTOR.state
- FXE_MOTOR_LPD1M-1/CORRELATOR.start
- FXE_RR_SYS/ZMQ/LPD1M1_MOTOR.deactivate
- FXE_RR_SYS/CORRELATION/JF_MOTOR.stop
- FXE_MOTOR_LPD1M-1/COR/ZMQ.deactivate
- FXE_RR_SYS/ZMQ/JF_MOTOR.data_sent0
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.detectorProperty
- FXE_MOTOR_LPD1M-1/CORRELATOR.channel
- FXE_MOTOR_LPD1M-1/CORRELATOR.processing.latestBufferSize
- FXE_MOTOR_JF500K/CORRELATOR.detectorId
- FXE_MOTOR_LPD1M-1/CORRELATOR.processing.latestSources
- FXE_MOTOR_LPD1M-1/CORRELATOR.processing.latestTid
- FXE_MOTOR_LPD1M-1/CORRELATOR._deviceId_
- FXE_MOTOR_LPD1M-1/COR/ZMQ.data_sent0
- FXE_MOTOR_LPD1M-1/CORRELATOR.slowTable
- FXE_MOTOR_LPD1M-1/COR/ZMQ.activate
- FXE_MOTOR_JF500K/CORRELATOR.detectorProperty
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.detectorId
- FXE_RR_SYS/ZMQ/JF_MOTOR.deactivate
- FXE_MOTOR_LPD1M-1/CORRELATOR.status
- FXE_MOTOR_JF500K/COR/ZMQ.activate
- FXE_RR_SYS/CORRELATION/LPD1M1_MOTOR.motorTable
- FXE_RR_SYS/CORRELATION/JF_MOTOR.channel
- FXE_MOTOR_LPD1M-1/CORRELATOR.motorTable

#### BeamPositionMonitor

projects: | TEST_BUNCH_DIGITIZER

- beamPositionMonitor.trainValidity
- beamPositionMonitor.deviceId
- beamPositionMonitor.output.schema.data.temporalIAvg
- beamPositionMonitor.output.schema.data.i
- beamPositionMonitor.output.schema.data.yAvg
- beamPositionMonitor.output.schema.data.temporalXAvg
- beamPositionMonitor.output.schema.data.temporalXSD
- beamPositionMonitor.quadrant
- beamPositionMonitor.output.schema.data.xAvg
- beamPositionMonitor.output.schema.data.temporalYAvg
- beamPositionMonitor.state
- beamPositionMonitor.pulseValidity
- beamPositionMonitor1.temporalAverage
- beamPositionMonitor.output.schema.data.temporalISD
- beamPositionMonitor.lowerBound
- beamPositionMonitor.output.schema.data.iAvg
- beamPositionMonitor.output.schema.data.y
- beamPositionMonitor.upperBound
- beamPositionMonitor.output.schema.data.temporalYSD
- beamPositionMonitor.output.schema.data.x
- apdData.state
- apdData.deviceId

#### FXE_XAD_TEST/MOTOR/TEST|motorScene

projects: | TEST_BUNCH_DIGITIZER

- FXE_XAD_TEST/MOTOR/TEST.stop
- FXE_XAD_TEST/MOTOR/TEST.isSWLimitHigh
- FXE_XAD_TEST/MOTOR/TEST.coupling.isMaster
- FXE_XAD_TEST/MOTOR/TEST.targetVelocity
- FXE_XAD_TEST/MOTOR/TEST.deviceId
- FXE_XAD_TEST/MOTOR/TEST.reset
- FXE_XAD_TEST/MOTOR/TEST.swLimitLow
- FXE_XAD_TEST/MOTOR/TEST.coupling.numerator
- FXE_XAD_TEST/MOTOR/TEST.coupling.denominator
- FXE_XAD_TEST/MOTOR/TEST.targetPosition
- FXE_XAD_TEST/MOTOR/TEST.coupling.isConfigurableAsSlave
- FXE_XAD_TEST/MOTOR/TEST.coupling.isSlave
- FXE_XAD_TEST/MOTOR/TEST.calibrateToEncoder
- FXE_XAD_TEST/MOTOR/TEST.stepUp
- FXE_XAD_TEST/MOTOR/TEST.encoderPosition
- FXE_XAD_TEST/MOTOR/TEST.move
- FXE_XAD_TEST/MOTOR/TEST.mc2.acc
- FXE_XAD_TEST/MOTOR/TEST.state
- FXE_XAD_TEST/MOTOR/TEST.calibrate
- FXE_XAD_TEST/MOTOR/TEST.on
- FXE_XAD_TEST/MOTOR/TEST.coupling.couple
- FXE_XAD_TEST/MOTOR/TEST.home
- FXE_XAD_TEST/MOTOR/TEST.mc2.maxVelocity
- FXE_XAD_TEST/MOTOR/TEST.isSWLimitLow
- FXE_XAD_TEST/MOTOR/TEST.coupling.masterDevice
- FXE_XAD_TEST/MOTOR/TEST.specificError
- FXE_XAD_TEST/MOTOR/TEST.isCCWLimit
- FXE_XAD_TEST/MOTOR/TEST.coupling.decouple
- FXE_XAD_TEST/MOTOR/TEST.enableSWLimitHigh
- FXE_XAD_TEST/MOTOR/TEST.requestHardwareValues
- FXE_XAD_TEST/MOTOR/TEST.isCWLimit
- FXE_XAD_TEST/MOTOR/TEST.enableSWLimitLow
- FXE_XAD_TEST/MOTOR/TEST.stepSize
- FXE_XAD_TEST/MOTOR/TEST.swLimitHigh
- FXE_XAD_TEST/MOTOR/TEST.actualPosition
- FXE_XAD_TEST/MOTOR/TEST.mc2.jerk
- FXE_XAD_TEST/MOTOR/TEST.resetAxis
- FXE_XAD_TEST/MOTOR/TEST.stepDown
- FXE_XAD_TEST/MOTOR/TEST.calibrateTarget
- FXE_XAD_TEST/MOTOR/TEST.off
- FXE_XAD_TEST/MOTOR/TEST.mc2.dec

#### FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Periodic SubPattern

projects: | FXE_LOOP6

- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.patternRepFactor
- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.subpattern_1.bunchOffset
- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.subpattern_3.bunchOffset
- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.subpattern_0.bunchOffset
- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.applyUserConfigToDoocs
- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.xfelBunchCharge,FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.doocsPplPattern,FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.userPplPattern
- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.subpattern_2.bunchOffset

#### FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN|Arbitrary SubPattern

projects: | FXE_LOOP6

- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.patternRepFactor
- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.applyUserConfigToDoocs
- FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.xfelBunchCharge,FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.doocsPplPattern,FXE_AUXT_LIC/DOOCS/PPL_M_PATTERN.userPplPattern

#### FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW|View All Patterns

projects: | FXE_LOOP6

- FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_SASE2.bunchCharge,FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_SASE2.pplPattern
- FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_SQS.bunchCharge,FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_SQS.pplPattern
- FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_15.bunchCharge,FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_15.pplPattern
- FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_LAS1.bunchCharge,FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_LAS1.pplPattern
- FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_SPB.bunchCharge,FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_SPB.pplPattern
- FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_FXE.bunchCharge,FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_FXE.pplPattern
- FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_LAS2.bunchCharge,FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_LAS2.pplPattern
- FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_SCS.bunchCharge,FXE_AUXT_LIC/DOOCS/PPL_PATTERN_OVERVIEW.pplPatterns.LP_SCS.pplPattern

#### FXE_SYS_VAC2MPS_DCTRL_FXE_VALVES_OPEN_INTERLOCK

projects: | FXE_BECKHOFF

- FXE_SYS_VAC2MPS/DCTRL/FXE_VALVES_OPEN.targetPosition

#### FXE_TO_MPS_DCTRL_BEAM_MODE1_INTERLOCK

projects: | FXE_BECKHOFF

- FXE_TO_MPS/DCTRL/BEAM_MODE1.targetPosition

#### FXE_TO_MPS_DCTRL_BEAM_MODEM_INTERLOCK

projects: | FXE_BECKHOFF

- FXE_TO_MPS/DCTRL/BEAM_MODEM.targetPosition

#### MONO-CRYO-POWER

projects: | FXE-VAC-SIGNAL-EXCHANGE

- FXE_XTD9_MONO-1/DCTRL/CRYO_POWER_2VAC.interlock.c2.ACndEnable
- FXE_XTD9_MONO-2/DCTRL/CRYO_POWER_2VAC.interlock.c2.ACndEnable

#### FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint

projects: | FXE_INTERLOCK

- FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint.interlock.AActionState
- FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint.interlock.AConditionState

#### FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state

projects: | FXE_INTERLOCK

- FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state.interlock.AActionState
- FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state.interlock.AConditionState

#### Control

projects: | TT_Michael

- FXE_SMS_USR/MOTOR/UM05.stepLength
- FXE_SMS_USR/MOTOR/UM11.stepLength
- FXE_SMS_USR/MOTOR/UM03.stepLength
- FXE_SMS_USR/MOTOR/UM08.stepLength
- FXE_SMS_USR/MOTOR/UM01.stepLength
- FXE_SMS_USR/MOTOR/UM02.stepLength

#### Custom_Motors-3

projects: | FXE_LOOP9

- FXE_SMS_MOV/MOTOR/Z_HIGH.on
- FXE_SMS_MOV/MOTOR/Z_HIGH.off
- FXE_SMS_MOV/MOTOR/Z_HIGH.stepUp
- FXE_SMS_MOV/MOTOR/Z_HIGH.targetPosition
- FXE_SMS_MOV/MOTOR/Z_HIGH.stepSize
- FXE_SMS_MOV/MOTOR/Z_HIGH.actualPosition
- FXE_SMS_MOV/MOTOR/Z_HIGH.move
- FXE_SMS_MOV/MOTOR/Z_HIGH.stop
- FXE_SMS_MOV/MOTOR/Z_HIGH.stepDown

#### JF1M

projects: | FXE_XAD_JF

- FXE_XAD_JF1M/DET/RECEIVER-1.deviceId
- FXE_XAD_JF1M/DET/RECEIVER-2.deviceId
- FXE_XAD_JF1M/DET/RECEIVER-2.frameRateIn
- FXE_XAD_JF1M/DET/RECEIVER-2.display.schema.data.adc
- Macro-FXE_XAD_JF1M/DET/BURST_CONFIGURATOR-50a310e8-d9d2-4fb5-82a3-7009651d41f8-FxeXadJfMDetBurstConfigurator.burstMode
- Macro-FXE_XAD_JF1M/DET/BURST_CONFIGURATOR-50a310e8-d9d2-4fb5-82a3-7009651d41f8-FxeXadJfMDetBurstConfigurator.state
- FXE_XAD_JF1M/DET/RECEIVER-1.frameRateIn
- FXE_XAD_JF1M/DET/RECEIVER-1.display.schema.data.adc
- Macro-FXE_XAD_JF1M/DET/BURST_CONFIGURATOR-50a310e8-d9d2-4fb5-82a3-7009651d41f8-FxeXadJfMDetBurstConfigurator.singleCell

#### FXE_DAQ_DATA/DM/CONFIGURATOR|scene

projects: | FXE_DAQ_RC_SCENE

- FXE_DAQ_DATA/DM/CONFIGURATOR.buildConfigurationInUse

#### FXE_RR_SYS/ILOCK/MAIN|Global interlock (overview)

projects: | FXE_INTERLOCK

- FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value.interlock.AConditionState
- FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint.interlock.AConditionState
- FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state.interlock.AConditionState
- FXE_OGT2_VAC/DCTRL/FV_OUTPUTCLOSE_state.interlock.AActionState
- FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint.interlock.AActionState
- FXE_OGT1_VAC/DCTRL/PSLIT1_IP150_on_setpoint.interlock.AConditionState
- FXE_OGT1_VAC_DCTRL_PSLIT1_FR_value.interlock.AActionState
- FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint.interlock.AActionState

#### Temperature0_Mono2

projects: | FXE_XTD9_MONO-1

- FXE_XTD9_MONO-2/TSENS/T0.value,FXE_XTD9_MONO-2/TSENS/T1.value,FXE_XTD9_MONO-2/TSENS/T2.value

#### FXE_DAQ_STATUS-OBSOLETE

projects: | FXE_RUN_MANAGEMENT

- FXE_DAQ_DATA/DA/6.state
- FXE_DAQ_DATA/DA/6.hostName
- FXE_DAQ_DATA/DA/5.state
- FXE_DAQ_DATA/DA/5.hostName

#### FXE_DAQ_RUN_CONTROL

projects: | FXE_DAQ_RC_SCENE

- FXE_DAQ_DATA/DA/5.state

#### PROCESSING

projects: | LPD_ONLINE_CAL

- FXE_DET_LPD1M/PROC/CORRECTED.x0,FXE_DET_LPD1M/PROC/CORRECTED.y0
- FXE_DET_LPD1M/PROC/CORRECTED.imageWidth
- FXE_DET_LPD1M/PROC/CORRECTED.subtractBkgImage
- FXE_DET_LPD1M/PROC/CORRECTED.imgX
- FXE_DET_LPD1M/PROC/CORRECTED.rangeForAuto
- FXE_DET_LPD1M/PROC/CORRECTED.frameRate
- FXE_DET_LPD1M/PROC/CORRECTED.maxPxValue
- FXE_DET_LPD1M/PROC/CORRECTED.meanPxValue
- FXE_DET_LPD1M/PROC/CORRECTED.filterImagesByThreshold
- FXE_DET_LPD1M/PROC/CORRECTED.imageThreshold
- FXE_DET_LPD1M/PROC/CORRECTED.userDefinedRange
- FXE_DET_LPD1M/PROC/CORRECTED.imageHeight
- FXE_DET_LPD1M/PROC/CORRECTED.useAsBackgroundImage
- FXE_DET_LPD1M/PROC/CORRECTED.doXYSum
- FXE_DET_LPD1M/PROC/CORRECTED.pixelSize
- FXE_DET_LPD1M/PROC/CORRECTED.imgY
- FXE_DET_LPD1M/PROC/CORRECTED.minPxValue
- FXE_DET_LPD1M/PROC/CORRECTED.subtractImagePedestal

#### CnC VETO Settings

projects: | LPD_CLOCK_CONTROL

- FXE_DET_LPD1M-1/CC/MON_0.veto_sim_counter

#### FXE_AUXT_CSLIT/MDL/MAIN|Control

projects: | FXE_AUXT_CSLIT

- FXE_AUXT_CSLIT/MOTOR/BLADE1_IN_OUT.on,FXE_AUXT_CSLIT/MOTOR/BLADE1_IN_OUT.off
- FXE_AUXT_CSLIT/MOTOR/BLADE4_IN_OUT.on,FXE_AUXT_CSLIT/MOTOR/BLADE4_IN_OUT.off
- FXE_AUXT_CSLIT/MOTOR/BLADE2_IN_OUT.on,FXE_AUXT_CSLIT/MOTOR/BLADE2_IN_OUT.off
- FXE_AUXT_CSLIT/MOTOR/BLADE3_IN_OUT.on,FXE_AUXT_CSLIT/MOTOR/BLADE3_IN_OUT.off

#### FXE_XTD9_MONO-1-CAM-BEAMVIEW-scene

projects: | FXE_XTD9_MONO-1

- FXE_XTD9_MONO-1/PROC/BEAMVIEW.regionMean,FXE_XTD9_MONO-1/PROC/BEAMVIEW.x0,FXE_XTD9_MONO-1/PROC/BEAMVIEW.y0
- FXE_XTD9_MONO-1/PROC/BEAMVIEW.output.schema.data.imgX,FXE_XTD9_MONO-1/PROC/BEAMVIEW.output.schema.data.imgY

#### FXE_OGT1_BIU_positions_and_projections

projects: | FXE_OGT1_BIU

- FXE_OGT1_BIU/PROC/CAMERA.imgX
- FXE_OGT1_BIU/PROC/CAMERA.imgY

#### FXE_RR_SYS/MON/PLC_1|Export PLC params

projects: | FXE_BECKHOFF

- FXE_RR_SYS/MON/PLC_1.status
- FXE_RR_SYS/MON/PLC_1.state
- FXE_RR_SYS/MON/PLC_1.getPLCsInSystem
- FXE_RR_SYS/MON/PLC_1.handleSingleConfigToXML
- FXE_RR_SYS/MON/PLC_1.handleMultiConfigToXML

#### FXE_OGT2_PSLIT/MDL/MAIN|Control

projects: | FXE_OGT2_PSLIT

- FXE_OGT2_PSLIT/MOTOR/BLADE1_IN_OUT.on,FXE_OGT2_PSLIT/MOTOR/BLADE1_IN_OUT.off
- FXE_OGT2_PSLIT/MOTOR/BLADE2_IN_OUT.on,FXE_OGT2_PSLIT/MOTOR/BLADE2_IN_OUT.off
- FXE_OGT2_PSLIT/MOTOR/BLADE3_IN_OUT.on,FXE_OGT2_PSLIT/MOTOR/BLADE3_IN_OUT.off
- FXE_OGT2_PSLIT/MOTOR/BLADE4_IN_OUT.on,FXE_OGT2_PSLIT/MOTOR/BLADE4_IN_OUT.off

#### FXE_OGT1_PSLIT/MDL/MAIN|Control

projects: | FXE_OGT1_PSLIT

- FXE_OGT1_PSLIT/MOTOR/BLADE3_IN_OUT.on,FXE_OGT1_PSLIT/MOTOR/BLADE3_IN_OUT.off
- FXE_OGT1_PSLIT/MOTOR/BLADE1_IN_OUT.on,FXE_OGT1_PSLIT/MOTOR/BLADE1_IN_OUT.off
- FXE_OGT1_PSLIT/MOTOR/BLADE4_IN_OUT.on,FXE_OGT1_PSLIT/MOTOR/BLADE4_IN_OUT.off
- FXE_OGT1_PSLIT/MOTOR/BLADE2_IN_OUT.on,FXE_OGT1_PSLIT/MOTOR/BLADE2_IN_OUT.off

#### XRAY_PULSE_ENERGY_MONITOR

projects: | AMAIN

- FXE_RR_DAQ/ADC/1.monitor.apd.d1.ch2.stddevOff
- FXE_RR_DAQ/ADC/1.monitor.apd.d1.ch2.meanOff

#### FXE_RR_SYS/MON/PLC_1|Control

projects: | AMAIN

- FXE_RR_SYS/MON/PLC_1.instantiateGroupDevices
- FXE_RR_SYS/MON/PLC_1.status
- FXE_RR_SYS/MON/PLC_1.groups
- FXE_RR_SYS/MON/PLC_1.shutdownDevices
- FXE_RR_SYS/MON/PLC_1.state
- FXE_RR_SYS/MON/PLC_1.resetDevices
- FXE_RR_SYS/MON/PLC_1.getOfflineDevices
- FXE_RR_SYS/MON/PLC_1.components
- FXE_RR_SYS/MON/PLC_1.shutdownComponentDevices
- FXE_RR_SYS/MON/PLC_1.deviceId
- FXE_RR_SYS/MON/PLC_1.shutdownGroupDevices
- FXE_RR_SYS/MON/PLC_1.instantiateComponentDevices
- FXE_RR_SYS/MON/PLC_1.instantiateDevices

#### FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint

projects: | FXE_INTERLOCK

- FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint.interlock.AConditionState
- FXE_OGT1_VAC/DCTRL/ATT_IP75_on_setpoint.interlock.AActionState

#### Gotthard_Calibration

projects: | FXE_OGT1_SA

- FXE_OGT1_SA/CAL/GOTTHARD.ppOutput.schema.data.image

#### ZMQ_OVERVIEW

projects: | ZMQ_BRIDGE

- FXE_DET_LPD1M-1/ZEROMQ_COR.deviceId
- FXE_DET_LPD1M-1/ZEROMQ_COR.receive_delay
- FXE_DET_LPD1M-1/ZEROMQ.conversion_time
- FXE_DET_LPD1M-1/ZEROMQ.input_updated
- FXE_DET_LPD1M-1/ZEROMQ.output.messaging_pattern
- FXE_DET_LPD1M-1/ZEROMQ_COR.input_updated
- FXE_DET_LPD1M-1/ZEROMQ_COR.output.serialize
- FXE_DET_LPD1M-1/CAL/APPEND_CORRECTED.rate
- FXE_DET_LPD1M-1/ZEROMQ.data_sent
- FXE_DET_LPD1M-1/ZEROMQ_COR.output.address
- FXE_DET_LPD1M-1/ZEROMQ.receive_delay
- FXE_DET_LPD1M-1/CAL/APPEND_RAW.rate
- FXE_DET_LPD1M-1/ZEROMQ.output.serialize
- FXE_DET_LPD1M-1/ZEROMQ.hostName
- FXE_DET_LPD1M-1/ZEROMQ.serialize_time
- FXE_DET_LPD1M-1/ZEROMQ.output.address
- FXE_DET_LPD1M-1/ZEROMQ_COR.state
- FXE_DET_LPD1M-1/ZEROMQ_COR.output.messaging_pattern
- FXE_DET_LPD1M-1/ZEROMQ_COR.data_sent
- FXE_DET_LPD1M-1/ZEROMQ.state
- FXE_DET_LPD1M-1/ZEROMQ.deviceId
- FXE_DET_LPD1M-1/ZEROMQ_COR.hostName
- FXE_DET_LPD1M-1/ZEROMQ_COR.conversion_time
- FXE_DET_LPD1M-1/ZEROMQ_COR.serialize_time

#### FXE_Mono1_Alio_Scanning

projects: | FXE_XTD9_MONO-1

- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.actualPosition,FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.stepCounterPosition,FXE_XTD9_MONO-1/PROC/BEAMVIEW.meanPxValue

#### FXE_XAD_PH3/DET/CAMERA|scene

projects: | FXE_XAD_PH3

- FXE_XAD_PH3/DET/CAMERA.output.schema.data.image
- FXE_XAD_PH3/DET/CAMERA.acquisitionFrameCount
- FXE_XAD_PH3/DET/CAMERA.trigger
- FXE_XAD_PH3/DET/CAMERA.exposureTime
- FXE_XAD_PH3/DET/CAMERA.stop
- FXE_XAD_PH3/DET/CAMERA.deviceId
- FXE_XAD_PH3/DET/CAMERA.reset
- FXE_XAD_PH3/DET/CAMERA.state
- FXE_XAD_PH3/DET/CAMERA.frameRate
- FXE_XAD_PH3/DET/CAMERA.acquire

#### STATS

projects: | LPD_ONLINE_CAL

- FXE_DET_LPD1M-1/CAL/COMBINE_CORRECTED.matchingStats.matchedModules,FXE_DET_LPD1M-1/CAL/COMBINE_CORRECTED.matchingStats.droppedModules,FXE_DET_LPD1M-1/CAL/COMBINE_CORRECTED.matchingStats.positionedModules
- FXE_DET_LPD1M-1/CAL/COMBINE_RAW.matchingStats.matchedModules,FXE_DET_LPD1M-1/CAL/COMBINE_RAW.matchingStats.droppedModules,FXE_DET_LPD1M-1/CAL/COMBINE_RAW.matchingStats.positionedModules

#### LA1_LAS_PPL/MDL/TRG_MOTOR

projects: | FXE_LOOP6

- LA1_LAS_PPL/MDL/TRG_MOTOR.remoteTopic
- LA1_LAS_PPL/MDL/TRG_MOTOR.stop
- LA1_LAS_PPL/MDL/TRG_MOTOR.move
- LA1_LAS_PPL/MDL/TRG_MOTOR.relativeValue
- LA1_LAS_PPL/MDL/TRG_MOTOR.remoteStatus
- LA1_LAS_PPL/MDL/TRG_MOTOR.deviceId
- LA1_LAS_PPL/MDL/TRG_MOTOR.state
- LA1_LAS_PPL/MDL/TRG_MOTOR.actualPosition
- LA1_LAS_PPL/MDL/TRG_MOTOR.targetPosition

#### FXE_RR_SYS/ILOCK/MAIN|Interlock for: FXE_OGT1_VAC/VALVE/GV1

projects: | FXE_INTERLOCK

- FXE_OGT2_VAC/SWITCH/FV_OUTPUTCLOSE_state_true.state
- SA1_XTD9_VAC/SWITCH/P12290I_on_setpoint.state

#### Temperature0

projects: | FXE_XTD9_MONO-1

- FXE_XTD9_MONO-1/TSENS/T0.value,FXE_XTD9_MONO-1/TSENS/T1.value,FXE_XTD9_MONO-1/TSENS/T2.value,FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.actualPosition

#### Q2M4 Investigation

projects: | LPD_Control

- FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor0Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor1Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor2Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor3Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor4Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor5Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor6Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor7Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor8Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor9Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor10Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor11Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor12Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor13Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor14Temp,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.sensor15Temp
- FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardFault0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardFault1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardFemStatus0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardFemStatus1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardExtStatus0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardExtStatus1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardOverCurrent0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardOverCurrent1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardOverTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardOverTemp1,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardUnderTemp0,FXE_DET_LPD1M-1/FPGA/FEM_Q2M4.powerCardUnderTemp1

#### FXE_XTD9_MONO-2/AVD/BEAMVIEW|scene0

projects: | FXE_XTD9_MONO-2

- FXE_XTD9_MONO-2/PROC/BEAMVIEW.output.schema.data.imgY,FXE_XTD9_MONO-2/PROC/BEAMVIEW.output.schema.data.imgX
- FXE_XTD9_MONO-2/MDL/ACCM_PITCH.deltaX
- FXE_XTD9_MONO-2/PROC/BEAMVIEW.y0,FXE_XTD9_MONO-2/PROC/BEAMVIEW.x0
- FXE_XTD9_MONO-2/AVG/BEAMVIEW.ppOutput.schema.data.image

#### FXE_XTD9_MONO-1-AVG-BEAMVIEW-scene0

projects: | FXE_XTD9_MONO-1

- FXE_XTD9_MONO-1/PROC/BEAMVIEW.regionMean,FXE_XTD9_MONO-1/PROC/BEAMVIEW.x0,FXE_XTD9_MONO-1/PROC/BEAMVIEW.y0
- FXE_XTD9_MONO-1/PROC/BEAMVIEW.output.schema.data.imgX,FXE_XTD9_MONO-1/PROC/BEAMVIEW.output.schema.data.imgY

#### GRID_CREATOR

projects: | FXE_SCANTOOL

- FXE_DAQ_SCAN/MDL/KARABACON.requestScanPattern

#### STAGE_LINEARITY_TEST

projects: | FXE_XTD9_MONO-1

- FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH.actualPosition,FXE_XTD9_MONO-1/ENC/ACCM_PITCH.value

#### FXE_SMS_JSS/MDL/CRYSTAL_GROUP|scene

projects: | FXE_JSS

- FXE_SMS_JSS/MDL/CRYSTAL1.availableScenes
- FXE_SMS_JSS/MDL/CRYSTAL2.state
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.targetPosition
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.move
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.stop
- FXE_SMS_JSS/MDL/CRYSTAL1.state
- FXE_SMS_JSS/MDL/CRYSTAL2.deviceId
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.reset
- FXE_SMS_JSS/MDL/CRYSTAL2.availableScenes
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.state
- FXE_SMS_JSS/MDL/CRYSTAL3.state
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.motorEnv
- FXE_SMS_JSS/MDL/CRYSTAL4.deviceId
- FXE_SMS_JSS/MDL/CRYSTAL3.deviceId
- FXE_SMS_JSS/MDL/CRYSTAL5.state
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.turnOn
- FXE_SMS_JSS/MDL/CRYSTAL4.state
- FXE_SMS_JSS/MDL/CRYSTAL3.availableScenes
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.classId
- FXE_SMS_JSS/MDL/CRYSTAL1.deviceId
- FXE_SMS_JSS/MDL/CRYSTAL5.availableScenes
- FXE_SMS_JSS/MDL/CRYSTAL5.deviceId
- FXE_SMS_JSS/MDL/CRYSTAL4.availableScenes
- FXE_SMS_JSS/MDL/CRYSTAL_GROUP.turnOff

#### FXE_OGT1_IPM_MAIN

projects: | FXE_DIGITIZER

- FXE_OGT1_IPM/MDL/MONITOR.output.schema.data.yAvg,FXE_OGT1_IPM/MDL/MONITOR.output.schema.data.temporalYAvg
- FXE_OGT1_IPM/MDL/MONITOR.output.schema.data.xAvg,FXE_OGT1_IPM/MDL/MONITOR.output.schema.data.temporalXAvg
- FXE_OGT1_IPM/MDL/MONITOR.output.schema.data.iAvg,FXE_OGT1_IPM/MDL/MONITOR.output.schema.data.temporalIAvg

#### FXE_PPL_LAS/MOTOR/STAGE_2|motorScene

projects: | FXE_PPL_LAS

- FXE_PPL_LAS/MOTOR/STAGE_2.enableSWLimitHigh
- FXE_PPL_LAS/MOTOR/STAGE_2.swLimitHigh
- FXE_PPL_LAS/MOTOR/STAGE_2.moveRelative
- FXE_PPL_LAS/MOTOR/STAGE_2.move
- FXE_PPL_LAS/MOTOR/STAGE_2.isCWLimit
- FXE_PPL_LAS/MOTOR/STAGE_2.coupling.couple
- FXE_PPL_LAS/MOTOR/STAGE_2.stop
- FXE_PPL_LAS/MOTOR/STAGE_2.targetPosition
- FXE_PPL_LAS/MOTOR/STAGE_2.coupling.isMaster
- FXE_PPL_LAS/MOTOR/STAGE_2.calibrate
- FXE_PPL_LAS/MOTOR/STAGE_2.coupling.numerator
- FXE_PPL_LAS/MOTOR/STAGE_2.isCCWLimit
- FXE_PPL_LAS/MOTOR/STAGE_2.actualPosition
- FXE_PPL_LAS/MOTOR/STAGE_2.coupling.isSlave
- FXE_PPL_LAS/MOTOR/STAGE_2.deviceId
- FXE_PPL_LAS/MOTOR/STAGE_2.home
- FXE_PPL_LAS/MOTOR/STAGE_2.calibrateTarget
- FXE_PPL_LAS/MOTOR/STAGE_2.enableSWLimitLow
- FXE_PPL_LAS/MOTOR/STAGE_2.isSWLimitLow
- FXE_PPL_LAS/MOTOR/STAGE_2.targetVelocity
- FXE_PPL_LAS/MOTOR/STAGE_2.mc2.acc
- FXE_PPL_LAS/MOTOR/STAGE_2.mc2.maxVelocity
- FXE_PPL_LAS/MOTOR/STAGE_2.specificError
- FXE_PPL_LAS/MOTOR/STAGE_2.coupling.isConfigurableAsSlave
- FXE_PPL_LAS/MOTOR/STAGE_2.requestHardwareValues
- FXE_PPL_LAS/MOTOR/STAGE_2.resetAxis
- FXE_PPL_LAS/MOTOR/STAGE_2.mc2.dec
- FXE_PPL_LAS/MOTOR/STAGE_2.coupling.masterDevice
- FXE_PPL_LAS/MOTOR/STAGE_2.off
- FXE_PPL_LAS/MOTOR/STAGE_2.reset
- FXE_PPL_LAS/MOTOR/STAGE_2.swLimitLow
- FXE_PPL_LAS/MOTOR/STAGE_2.mc2.jerk
- FXE_PPL_LAS/MOTOR/STAGE_2.coupling.denominator
- FXE_PPL_LAS/MOTOR/STAGE_2.coupling.decouple
- FXE_PPL_LAS/MOTOR/STAGE_2.calibrateToEncoder
- FXE_PPL_LAS/MOTOR/STAGE_2.on
- FXE_PPL_LAS/MOTOR/STAGE_2.isSWLimitHigh
- FXE_PPL_LAS/MOTOR/STAGE_2.stepSize
- FXE_PPL_LAS/MOTOR/STAGE_2.encoderPosition
- FXE_PPL_LAS/MOTOR/STAGE_2.state

#### FXE_RR_MPOD-1/MCPS/MPOD|overview

projects: | FXE_RR_MPOD

- FXE_RR_MPOD-1/MCPS/MPOD.channels.U6.state
- FXE_RR_MPOD-1/MCPS/MPOD.channels.U4.state
- FXE_RR_MPOD-1/MCPS/MPOD.channels.U5.state
- FXE_RR_MPOD-1/MCPS/MPOD.channels.U7.state

#### logtest

projects: | FXE_LOOP1

- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.category
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.logbook
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.post
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.type
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.text
- Macro-Logbook-be92aa91-dd9b-4c6e-a7ef-dc4ba4ea9bdc-Logbook.subject

#### FXE_IPM_CORR

projects: | FXE_DIGITIZER

- FXE_AUXT_DWI0/MDL/MONITOR.output.schema.data.iAvg,FXE_OGT1_IPM/MDL/MONITOR.output.schema.data.xAvg
- FXE_AUXT_DWI0/MDL/MONITOR.output.schema.data.iAvg,FXE_OGT1_IPM/MDL/MONITOR.output.schema.data.yAvg

#### FXE_AUXT_DWI0_MAIN

projects: | FXE_DIGITIZER

- FXE_AUXT_DWI0/MDL/MONITOR.output.schema.data.yAvg,FXE_AUXT_DWI0/MDL/MONITOR.output.schema.data.temporalYAvg
- FXE_AUXT_DWI0/MDL/MONITOR.output.schema.data.iAvg,FXE_AUXT_DWI0/MDL/MONITOR.output.schema.data.temporalIAvg
- FXE_AUXT_DWI0/MDL/MONITOR.output.schema.data.xAvg,FXE_AUXT_DWI0/MDL/MONITOR.output.schema.data.temporalXAvg

#### PLCsStateOverview

projects: | PLC_EEE_Tool

- HED_RR_SYS/PLC/11_PLCMON.APlcProjectVersion
- HED_RR_SYS/PLC/1.instantiateDevices
- HED_RR_SYS/PLC/13.byteRateOut
- HED_RR_SYS/PLC/12.state
- HED_RR_SYS/PLC/12.byteRateOut
- HED_RR_SYS/PLC/11.byteRateOut
- HED_RR_SYS/PLC/11_PLCMON.fwVersion
- HED_RR_SYS/PLC/14.state
- HED_RR_SYS/PLC/13_PLCMON.fwVersion
- HED_RR_SYS/PLC/14_PLCMON.APlcProjectVersion
- HED_RR_SYS/PLC/12.instantiateDevices
- HED_RR_SYS/PLC/14_PLCMON.fwVersion
- HED_RR_SYS/PLC/13.state
- HED_RR_SYS/PLC/13_PLCMON.APlcProjectVersion
- HED_RR_SYS/PLC/13.instantiateDevices
- HED_RR_SYS/PLC/12_PLCMON.APlcProjectVersion
- HED_RR_SYS/PLC/11.instantiateDevices
- HED_RR_SYS/PLC/12_PLCMON.fwVersion
- HED_RR_SYS/PLC/1.state
- HED_RR_SYS/PLC/11.state
- HED_RR_SYS/PLC/14.instantiateDevices
- HED_RR_SYS/PLC/14.byteRateOut

#### FXE_OGT3_IPM_MAIN

projects: | FXE_DIGITIZER

- FXE_OGT3_IPM/MDL/MONITOR.output.schema.data.iAvg,FXE_OGT3_IPM/MDL/MONITOR.output.schema.data.temporalIAvg
- FXE_OGT3_IPM/MDL/MONITOR.output.schema.data.yAvg,FXE_OGT3_IPM/MDL/MONITOR.output.schema.data.temporalYAvg
- FXE_OGT3_IPM/MDL/MONITOR.output.schema.data.xAvg,FXE_OGT3_IPM/MDL/MONITOR.output.schema.data.temporalXAvg

#### CONFIG_SCENE

projects: | FXE_CONF_MANAGER

- FXE_OGT1_PSLIT/MDL/COM_MANAGER.availableScenes
- FXE_SMS_VHS/MDL/COM_MANAGER.availableScenes

#### Robot

projects: | TEST_TOPA

- robotFXE.DownRY
- robotFXE.currentJoints.J5
- robotFXE.currentJoints.J6
- robotFXE.rbvConnected
- robotFXE.targetPosition.RZ
- robotFXE.targetJoints.J3
- robotFXE.rbkPosition.RZ
- robotFXE.stepPosition.Z
- robotFXE.targetPosition.X
- robotFXE.UpRY
- robotFXE.targetJoints.J5
- robotFXE.isSettle
- robotFXE.setPowerDisable
- robotFXE.stepPosition.Y
- robotFXE.targetPosition.Z
- robotFXE.targetPosition.RX
- robotFXE.targetJoints.J1
- robotFXE.setJoints
- robotFXE.currentJoints.J1
- robotFXE.stepPosition.RX
- robotFXE.targetJoints.J4
- robotFXE.targetJoints.J6
- robotFXE.stopAll
- robotFXE.DownZ
- robotFXE.rcvConnected
- robotFXE.rbkPosition.Z
- robotFXE.targetPosition.RY
- robotFXE.currentJoints.J4
- robotFXE.UpRX
- robotFXE.targetJoints.J2
- robotFXE.pActual
- robotFXE.UpZ
- robotFXE.UpRZ
- robotFXE.rbkPosition.RX
- robotFXE.stepPosition.X
- robotFXE.setPowerEnable
- robotFXE.DownRZ
- robotFXE.speedMonitor
- robotFXE.setPosition
- robotFXE.UpX
- robotFXE.getActual
- robotFXE.pTarget
- robotFXE.targetPosition.Y
- robotFXE.rbkPosition.RY
- robotFXE.rbkPosition.Y
- robotFXE.DownRX
- robotFXE.stepPosition.RZ
- robotFXE.rbkPosition.X
- robotFXE.UpY
- robotFXE.stepPosition.RY
- robotFXE.currentJoints.J2
- robotFXE.isPower
- robotFXE.currentJoints.J3
- robotFXE.DownX
- robotFXE.DownY

#### RunValidator

projects: | RUN_VALIDATOR

- FXE_DAQ_DA/RUN_VALIDATOR/1.RunControllers
- FXE_DAQ_DA/RUN_VALIDATOR/1.state
- FXE_DAQ_DA/RUN_VALIDATOR/1.deviceId
- FXE_DAQ_DA/RUN_VALIDATOR/1.status
- FXE_DAQ_DA/RUN_VALIDATOR/1.History

#### TopasMdl

projects: | TEST_TOPA

- TopasFXE.closeShutter
- TopasFXE.progressRBV
- TopasFXE.interactionRBV
- TopasFXE.signalRBV
- TopasFXE.reqActRBV
- TopasFXE.confirmAction
- TopasFXE.stepDown
- TopasFXE.outputRBV
- TopasFXE.stepUp
- TopasFXE.errorMessage
- TopasFXE.setIsSuccess
- TopasFXE.openShutter
- TopasFXE.shutterRBV
- TopasFXE.targetInteraction
- TopasFXE.idlerRBV
- TopasFXE.targetOutput
- TopasFXE.stepSize
- TopasFXE.userMessage.text

#### TopasMotors

projects: | TEST_TOPA

- TopasFXE.opaMotors.motor1.stepDown
- TopasFXE.opaMotors.motor1.motorName
- TopasFXE.opaMotors.motor1.currentPosition
- TopasFXE.opaMotors.motor1.leftSwitch
- TopasFXE.opaMotors.motor1.motorIndex
- TopasFXE.opaMotors.motor1.rightSwitch
- TopasFXE.opaMotors.motor1.stepSize
- TopasFXE.opaMotors.motor1.isMoving
- TopasFXE.opaMotors.motor1.targetPosition
- TopasFXE.opaMotors.motor1.stepUp

#### IntensityScan_toDelete0604

projects: | FXE_OGT1_ATT

- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.run
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.acq_time
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.openPos
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.start
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.closePos
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.darks
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.end
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.steps
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.message
- Macro-IntensityScan_v0ALF-ca40c639-12c6-476b-85e8-28a9a90ce735-IntensityScan.darks_acq_time

#### IntensityScan2

projects: | FXE_OGT1_ATT

- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.att_timeout
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.end
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.slt_timeout
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.darks_acq_time
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.run
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.start
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.closePos
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.steps
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.openPos
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.message
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.darks
- Macro-IntensityScan_v2ALF0-d18b83a9-308f-45ee-9bdd-3c1da5922330-IntensityScan.acq_time

#### DOC_TROUBLESHOOT

projects: | DET_LPD

- FXE_DET_LPD1M-1/CAL/RESTART.execute

#### FXE_ILH_AUX/COMPM/MOTORS_STATE|scene

projects: | FXE_CONF_MANAGER

- FXE_ILH_AUX/COMPM/MOTORS_STATE.lastSuccess
- FXE_ILH_AUX/COMPM/MOTORS_STATE.view
- FXE_ILH_AUX/COMPM/MOTORS_STATE.deviceHeartBeat
- FXE_ILH_AUX/COMPM/MOTORS_STATE.selectionList
- FXE_ILH_AUX/COMPM/MOTORS_STATE.forceShutdown
- FXE_ILH_AUX/COMPM/MOTORS_STATE.saveConfigurations
- FXE_ILH_AUX/COMPM/MOTORS_STATE.configurationName
- FXE_ILH_AUX/COMPM/MOTORS_STATE.stopInstantiate
- FXE_ILH_AUX/COMPM/MOTORS_STATE.verifyConfigurations
- FXE_ILH_AUX/COMPM/MOTORS_STATE.description
- FXE_ILH_AUX/COMPM/MOTORS_STATE.state
- FXE_ILH_AUX/COMPM/MOTORS_STATE.priority
- FXE_ILH_AUX/COMPM/MOTORS_STATE.status
- FXE_ILH_AUX/COMPM/MOTORS_STATE.applyConfigurations
- FXE_ILH_AUX/COMPM/MOTORS_STATE.startInstantiate
- FXE_ILH_AUX/COMPM/MOTORS_STATE.deviceId
- FXE_ILH_AUX/COMPM/MOTORS_STATE.overwritable
- FXE_ILH_AUX/COMPM/MOTORS_STATE.listConfigurations
- FXE_ILH_AUX/COMPM/MOTORS_STATE.deviceNames
- FXE_ILH_AUX/COMPM/MOTORS_STATE.progress

#### FXE_OGT3_PAM/DET/CONTROL_SIG

projects: | FXE_OGT3_PAM

- FXE_OGT3_PAM/CAL/CONTROL_SIG.state
- FXE_OGT3_PAM/CAL/CONTROL_SIG.frameToDisplay
- FXE_OGT3_PAM/CAL/CONTROL_SIG.display.schema.calibratedData

#### FXE_OGT3_PAM/DET/CONTROL_REF

projects: | FXE_OGT3_PAM

- FXE_OGT3_PAM/DET/CONTROL_REF.timing
- FXE_OGT3_PAM/DET/CONTROL_REF.delayAfterTrigger
- FXE_OGT3_PAM/DET/CONTROL_REF.exposureTime
- FXE_OGT3_PAM/DET/CONTROL_REF.numberOfGates
- FXE_OGT3_PAM/DET/CONTROL_REF.start
- FXE_OGT3_PAM/DET/CONTROL_REF.tempAdc
- FXE_OGT3_PAM/DET/CONTROL_REF.reset
- FXE_OGT3_PAM/DET/CONTROL_REF.vHighVoltage
- FXE_OGT3_PAM/DET/CONTROL_REF.state
- FXE_OGT3_PAM/DET/CONTROL_REF.stop
- FXE_OGT3_PAM/DET/CONTROL_REF.numberOfCycles
- FXE_OGT3_PAM/DET/CONTROL_REF.exposurePeriod
- FXE_OGT3_PAM/DET/CONTROL_REF.settings
- FXE_OGT3_PAM/DET/CONTROL_REF.tempFpga
- FXE_OGT3_PAM/DET/CONTROL_REF.triggerPeriod
- FXE_OGT3_PAM/DET/CONTROL_REF.numberOfFrames

#### FXE_SMS_ROB_XRD

projects: | FXE_SMS_MOV

- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.Rx_deg
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.TTheta_v_deg
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.Ry_deg
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.execute
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.Rz_deg
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.x
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.y
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.Radius
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.TTheta_h_deg
- Macro-ROBOT_2THETA_TO_POS-36639006-5bae-4830-bbb9-73529b87e347-RobotThetaToPos.z

#### FXE_SMS_MOV/COMPM/MOTORS|scene

projects: | FXE_CONF_MANAGER

- FXE_SMS_MOV/COMPM/MOTORS.verifyConfigurations
- FXE_SMS_MOV/COMPM/MOTORS.deviceNames
- FXE_SMS_MOV/COMPM/MOTORS.stopInstantiate
- FXE_SMS_MOV/COMPM/MOTORS.status
- FXE_SMS_MOV/COMPM/MOTORS.deviceId
- FXE_SMS_MOV/COMPM/MOTORS.forceShutdown
- FXE_SMS_MOV/COMPM/MOTORS.startInstantiate
- FXE_SMS_MOV/COMPM/MOTORS.view
- FXE_SMS_MOV/COMPM/MOTORS.listConfigurations
- FXE_SMS_MOV/COMPM/MOTORS.configurationName
- FXE_SMS_MOV/COMPM/MOTORS.priority
- FXE_SMS_MOV/COMPM/MOTORS.overwritable
- FXE_SMS_MOV/COMPM/MOTORS.lastSuccess
- FXE_SMS_MOV/COMPM/MOTORS.selectionList
- FXE_SMS_MOV/COMPM/MOTORS.applyConfigurations
- FXE_SMS_MOV/COMPM/MOTORS.progress
- FXE_SMS_MOV/COMPM/MOTORS.state
- FXE_SMS_MOV/COMPM/MOTORS.saveConfigurations
- FXE_SMS_MOV/COMPM/MOTORS.description
- FXE_SMS_MOV/COMPM/MOTORS.deviceHeartBeat

#### CnC VETO Settings (Duplicate MON_1)

projects: | LPD_CLOCK_CONTROL

- FXE_DET_LPD1M-1/CC/MON_1.veto_sim_counter

#### CnC Spare Trigger (Duplicate MON_1)

projects: | LPD_CLOCK_CONTROL

- FXE_DET_LPD1M-1/CC/MON_1.upload_mask_values

#### FXE_SMS_ROB_FAL

projects: | FXE_SMS_MOV

- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.z
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.execute
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.Radius
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.TTheta_h_deg
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.Ry_deg
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.TTheta_v_deg
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.Rz_deg
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.y
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.x
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.Rx_deg
- Macro-ROBOT_2THETA_FAL-fb5dae6d-ef03-4396-8edb-7d4824534706-RobotThetaToPos.vector

Read the Docs v: latest

Versions
  latest

Downloads
  html

On Read the Docs
  Project Home
  Builds

Free document hosting provided by Read the Docs.